RibbonEditBox Interface
Represents an edit box on a Ribbon.
Namespace: Microsoft.Office.Tools.Ribbon
Assembly: Microsoft.Office.Tools.Common (in Microsoft.Office.Tools.Common.dll)
Syntax
'Declaration
<GuidAttribute("14396b39-63c4-4fc2-92fe-cbccdbe5f306")> _
Public Interface RibbonEditBox _
Inherits RibbonControl, RibbonComponent, IComponent, IDisposable
[GuidAttribute("14396b39-63c4-4fc2-92fe-cbccdbe5f306")]
public interface RibbonEditBox : RibbonControl,
RibbonComponent, IComponent, IDisposable
The RibbonEditBox type exposes the following members.
Properties
| Name | Description | |
|---|---|---|
.gif "Public property") |
Enabled | Gets or sets a value that indicates whether this RibbonControl is enabled. (Inherited from RibbonControl.) |
|
Id | Gets a string that Microsoft Office uses to identify this RibbonControl object. (Inherited from RibbonControl.) |
|
Image | Gets or sets the image that is displayed on the edit box. |
|
ImageName | Gets or sets the name that you can use to identify the image in the LoadImage event handler. |
|
KeyTip | Gets or sets the keyboard shortcut for this RibbonEditBox. |
|
Label | Gets or sets the text that appears on this RibbonEditBox. |
|
MaxLength | Gets or sets a value that indicates the maximum number of characters allowed per entry in this RibbonEditBox. |
|
Name | Gets or sets the name of this RibbonComponent. (Inherited from RibbonComponent.) |
|
OfficeImageId | Gets or sets the image to display on the button, if you want to use a built-in Microsoft Office icon. |
|
Parent | Gets a RibbonComponent that represents the parent of this RibbonComponent. (Inherited from RibbonComponent.) |
|
Ribbon | Gets the top-level Ribbon object that contains the control hierarchy. (Inherited from RibbonComponent.) |
|
RibbonUI | Infrastructure. Gets the IRibbonUI instance that is provided by the Microsoft Office application to the Ribbon extensibility code. (Inherited from RibbonComponent.) |
|
ScreenTip | Gets or sets tip text that appears when the user moves the pointer over the RibbonEditBox. |
|
ShowImage | Gets or sets a value that indicates whether the image that is associated with the RibbonEditBox is visible. |
|
ShowLabel | Gets or sets a value that indicates whether the label for this RibbonEditBox is visible. |
|
Site | Gets or sets the ISite associated with the IComponent. (Inherited from IComponent.) |
|
SizeString | Gets or sets a string that determines the size of the RibbonEditBox. |
|
SuperTip | Gets or sets multiline tip text that appears when the user moves the pointer over the RibbonEditBox. |
|
Tag | Gets or sets application-specific data that is associated with this RibbonComponent. (Inherited from RibbonComponent.) |
|
Text | Gets or sets text that appears in this RibbonEditBox when the edit box first appears. |
|
Visible | Gets or sets a value that indicates whether this RibbonControl is visible. (Inherited from RibbonControl.) |
Top
Methods
| Name | Description | |
|---|---|---|
.gif "Public method") |
Dispose | Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. (Inherited from IDisposable.) |
|
PerformDynamicLayout | Calls the Microsoft.Office.Core.IRibbonUI.InvalidateControl method of the parent control if the RibbonComponent has a dynamic parent, such as a dynamic menu, and layout is not suspended. (Inherited from RibbonComponent.) |
|
PerformLayout | Calls Microsoft.Office.Core.IRibbonUI.InvalidateControl if the RibbonComponent has a parent and layout is not suspended. (Inherited from RibbonComponent.) |
|
ResumeLayout() | Reverses the effect of the SuspendLayout method. (Inherited from RibbonComponent.) |
|
ResumeLayout(Boolean) | Reverses the effect of the SuspendLayout method. (Inherited from RibbonComponent.) |
|
SuspendLayout | Prevents the Microsoft Office application from refreshing the state of controls on the Ribbon. (Inherited from RibbonComponent.) |
Top
Events
| Name | Description | |
|---|---|---|
.gif "Public event") |
Disposed | Represents the method that handles the Disposed event of a component. (Inherited from IComponent.) |
|
TextChanged | Occurs when a user changes the text in the RibbonEditBox. |
Top
Remarks
The RibbonEditBox control displays a labeled box in which users can type and edit text.
Visual Studio creates an RibbonEditBox object when you drag an EditBox control from the Office Ribbon Controls tab of the Toolbox onto the Ribbon Designer.
You can create a RibbonEditBox at run time by using the CreateRibbonEditBox method of the RibbonFactory object.
There are two ways to access the RibbonFactory object:
By using the Factory property of the Ribbon class. Use this approach from code in your Ribbon class.
By using the Globals.Factory.GetRibbonFactory method. Use this approach from code outside your Ribbon class.
Some properties of this control can be set only before the Ribbon is loaded into the Office application. For information about setting these properties, see Ribbon Object Model Overview.
Note
This interface is implemented by the Visual Studio Tools for Office runtime. It is not intended to be implemented in your code. For more information, see Visual Studio Tools for Office Runtime Overview.
Usage
This documentation describes the version of this type that is used in Office projects that target the .NET Framework 4 and the .NET Framework 4.5. In projects that target the .NET Framework 3.5, this type might have different members and the code examples provided for this type might not work. For documentation about this type in projects that target the .NET Framework 3.5, see the following reference section in the Visual Studio 2008 documentation: https://go.microsoft.com/fwlink/?LinkId=160658.
See Also
Reference
Microsoft.Office.Tools.Ribbon Namespace