RibbonButton.OfficeImageId Property (2007 System)
Gets or sets the image to display on the button, if you want to use a built-in Microsoft Office icon.
Namespace: Microsoft.Office.Tools.Ribbon
Assembly: Microsoft.Office.Tools.Common.v9.0 (in Microsoft.Office.Tools.Common.v9.0.dll)
Syntax
'Declaration
Public Property OfficeImageId As String
'Usage
Dim instance As RibbonButton
Dim value As String
value = instance.OfficeImageId
instance.OfficeImageId = value
public string OfficeImageId { get; set; }
public:
property String^ OfficeImageId {
String^ get ();
void set (String^ value);
}
public function get OfficeImageId () : String
public function set OfficeImageId (value : String)
Property Value
Type: System.String
The ID of a built-in Microsoft Office icon that serves as the icon for this control.
Remarks
The OfficeImageId property identifies an Office icon that is displayed by the control. The property value is a string that identifies the imageMso value of the selected icon. This property can be set at design time or at run time. If you update this property at run time, the control's appearance is updated to reflect the change.
For a list of imageMso values, see the Microsoft Download Center page 2007 Office System Add-In: Icons Gallery.
This property is ignored if the Image property is set. Images identified by the OfficeImageId property can be loaded slightly faster than images identified by the Image property, because the images are cached in the Office application.
The ShowImage property must be true for the control to display the image. When you set the OfficeImageId property at design time, Visual Studio Tools for Office automatically sets the ShowImage property to true. If you set the OfficeImageId property at run time, you must set the ShowImage property to true in your code.
Examples
The following example assigns a Microsoft Office icon to a button.
To run this code example, you must first perform the following steps:
Add a Ribbon (Visual Designer) item to a Visual Studio Tools for Office project.
Add a group to the custom tab.
Add a button to the group.
Set the (Name) property of the button to mySaveButton.
Private Sub SetButtonImage()
mySaveButton.OfficeImageId = "FileSave"
mySaveButton.ShowImage = True
End Sub
private void SetButtonImage()
{
mySaveButton.OfficeImageId = "FileSave";
mySaveButton.ShowImage = true;
}
.NET Framework Security
- Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.
See Also
Reference
Microsoft.Office.Tools.Ribbon Namespace