Version

RibbonToolHelper Class Members

The following tables list the members exposed by RibbonToolHelper.

Public Fields
 NameDescription
Public Fieldstatic (Shared in Visual Basic)CaptionPropertyIdentifies the Caption attached dependency property which determines the caption of a tool.  
Public Fieldstatic (Shared in Visual Basic)HasCaptionPropertyIdentifies the read-only HasCaption attached dependency property which determines if the CaptionProperty has been set for a given tool.  
Public Fieldstatic (Shared in Visual Basic)HasImagePropertyIdentifies the read-only HasImage attached dependency property which determines if the ImageResolved property for a tool.  
Public Fieldstatic (Shared in Visual Basic)IdPropertyIdentifies the Id attached dependency property which is used to uniquely identify related tools within a XamRibbon.  
Public Fieldstatic (Shared in Visual Basic)ImageResolvedPropertyIdentifies the read-only ImageResolved attached dependency property which returns the large or small image of the tool depending on its current state.  
Public Fieldstatic (Shared in Visual Basic)IsOnQatPropertyIdentifies the read-only IsOnQat attached dependency property which indicates if an instance of the tool is on the QuickAccessToolbar.  
Public Fieldstatic (Shared in Visual Basic)IsQatCommonToolPropertyIdentifies the IsQatCommonTool attached dependency property which is used to  
Public Fieldstatic (Shared in Visual Basic)KeyTipPropertyIdentifies the KeyTip attached dependency property which is used to identify the tool when navigating within a XamRibbon using its keytips.  
Public Fieldstatic (Shared in Visual Basic)LargeImagePropertyIdentifies the LargeImage attached dependency property which determines the large image that represents the tool.  
Public Fieldstatic (Shared in Visual Basic)SizingModePropertyIdentifies the read-only SizingMode attached dependency property which indicates the current size of given tool within a RibbonGroup.  
Public Fieldstatic (Shared in Visual Basic)SmallImagePropertyIdentifies the SmallImage attached dependency property which determines the small image that represents the tool.  
Public Methods
 NameDescription
Public Methodstatic (Shared in Visual Basic)GetCaptionGets the string caption associated with a given XamRibbon tool.  
Public Methodstatic (Shared in Visual Basic)GetHasCaptionReturns a boolean indicating if the CaptionProperty has been set for a given tool.  
Public Methodstatic (Shared in Visual Basic)GetHasImageReturns a boolean indicating if the tool has an image associated with it.  
Public Methodstatic (Shared in Visual Basic)GetIdGets the string used to uniquely identify instances of the same logical tool within the XamRibbon  
Public Methodstatic (Shared in Visual Basic)GetImageResolvedReturns the resolved image for a given tool within the XamRibbon  
Public Methodstatic (Shared in Visual Basic)GetIsOnQatReturns a boolean indicating if an instance of the tool is on the QuickAccessToolbar.  
Public Methodstatic (Shared in Visual Basic)GetIsQatCommonToolReturns true if the tool should be shown in the list of 'common tools' displayed in the Quick Customize Menu of the QuickAccessToolbar.  
Public Methodstatic (Shared in Visual Basic)GetKeyTipReturns a string used when navigating the XamRibbon when using keytips.  
Public Methodstatic (Shared in Visual Basic)GetLargeImageReturns the image that should be used when the tool is in its large state.  
Public Methodstatic (Shared in Visual Basic)GetSizingModeReturns the current sizing mode of a tool within a RibbonGroup  
Public Methodstatic (Shared in Visual Basic)GetSmallImageReturns the image that should be used when the tool is in its normal state.  
Public Methodstatic (Shared in Visual Basic)SetCaptionSets the strings caption for a given XamRibbon tool  
Public Methodstatic (Shared in Visual Basic)SetIdProvides the string used to uniquely identify instances of the same logical tool within the XamRibbon  
Public Methodstatic (Shared in Visual Basic)SetIsQatCommonToolDetermines if the specified tool is shown in the list of 'common tools' displayed in the Quick Customize Menu of the QuickAccessToolbar.  
Public Methodstatic (Shared in Visual Basic)SetKeyTipSets the string with a maximum length of 3 characters that is used when navigating the XamRibbon when using keytips.  
Public Methodstatic (Shared in Visual Basic)SetLargeImageSets the image that should be used when the tool is in its large state.  
Public Methodstatic (Shared in Visual Basic)SetSmallImageSets the image that should be used when the tool is in its normal state.  
See Also