RecentPinItem Class

A pin item within the Recent Item Control.

Namespace: DevExpress.XtraBars.Ribbon

Assembly: DevExpress.XtraBars.v20.1.dll

Declaration

public class RecentPinItem :
    RecentTextGlyphItemBase
Public Class RecentPinItem
    Inherits RecentTextGlyphItemBase

Related API Members

The following members accept/return RecentPinItem objects:

Remarks

RecentPinItems are objects capable of displaying two text strings (the RecentTextGlyphItemBase.Caption and RecentPinItem.Description properties) and an image (see the following figure).

RecentItemControl - Pin Items

Depending on the RecentPinItem.PinButtonVisibility property value, these items can display pin buttons. Clicking these buttons at runtime raises the RecentPinItem.PinButtonCheckedChanged event and toggles the boolean RecentPinItem.PinButtonChecked property value. Handle this event to implement the desired functionality, invoked on pinning or unpinning an item.

In order to implement your own pin item functionality, you first need to disable the default behavior by setting the RecentPanelBase.MovePinnedItemsUp property to false. The default behavior emulates the related behavior seen in Microsoft Office applications. The pinned pin item seeks the first element, and moves up until it meets the first item that is not another pin item or a separator. The automatically added separator detaches these pinned elements from regular pin items.

See the Recent Item Control topic to learn more about pin items, as well as other elements provided by the RecentItemControl.

See Also