The following tables list the members exposed by ToolBase.
Name | Description | |
---|---|---|
tagValue | (Inherited from Infragistics.Shared.SubObjectBase) |
Name | Description | |
---|---|---|
AccessibilityObject | Returns the System.Windows.Forms.AccessibleObject for this tool. | |
AccessibleRoleResolved | Returns the accessible role for this tool. | |
AllowMultipleInstancesResolved | Returns the value of the AllowMultipleInstances property on the SharedProps object of the UnderlyingTool. | |
Bounds | Gets the location and size of the tool in screen coordinates. | |
CanActivate | Returns whether the ToolBase can become the active ToolBase. | |
CaptionResolved | Returns the resolved value of the ToolPropsBase.Caption property on the SharedProps and InstanceProps objects, taking into account any customization performed by the end user. | |
ComponentRole | Returns the ComponentRole of the UltraToolbarsManager | |
Control | Returns the Control attached to the tool (read-only). | |
CustomizedCaption | Returns or sets the value of any user customization of the ToolPropsBase.Caption property. | |
CustomizedDisplayStyle | Returns or sets the value of any user customization of the ToolPropsBase.DisplayStyle property. | |
CustomizedImage | Returns or sets the value of any user customization of the Image displayed by the tool. | |
CustomizedIsFirstInGroup | Returns or sets the value of any user customization of the InstanceProps.IsFirstInGroup property. | |
CustomizedRecentlyUsed | Returns or sets the value of any user customization of the InstanceProps.RecentlyUsed property. | |
CustomizedVisible | Returns the value of any user customization of the visibility of the tool. | |
CustomizerCaptionResolved | Returns the string that will appear in the Customize dialog's 'Commands' list. | |
CustomizerDescriptionResolved | Returns the resolved value of the CustomizerDescription property on the SharedProps object of the UnderlyingTool. | |
DefaultSize | Returns the default size of the tool (read-only). | |
DisplayStyleResolved | Returns the resolved value of the ToolPropsBase.DisplayStyle property on the SharedProps and InstanceProps objects, taking into account any customization performed by the end user. | |
Disposed | (Inherited from Infragistics.Shared.DisposableObject) | |
EnabledResolved | Returns whether the tool is enabled. It resolves the value based on the SharedProps's Enabled and UltraToolbarsManager's Enabled properties. | |
Height | Returns the height of this instance of the tool. | |
Index | Returns the index of the tool in the ToolsCollectionBase. This property is read-only. | |
InstanceDisplaysImage | Returns whether this tool instance displays its image. | |
InstanceDisplaysText | Returns whether this tool instance displays its text. | |
InstanceProps | Returns the InstanceProps object which contains properties that are unique to a ToolBase instance. | |
IsActiveTool | Returns or sets whether this ToolBase is the active ToolBase. | |
IsControlContainer | Returns whether the tool is a container tool that can contain other controls. This property is read-only. | |
IsFirstInGroupResolved | Returns the resolved value of the InstanceProps.IsFirstInGroup property, taking into account any customization performed by the end user. | |
IsPopularCommand | Returns whether this ToolBase is a PopularCommand | |
IsRootTool | Returns whether the ToolBase is a root ToolBase (i.e., is in the UltraToolbarsManager component's UltraToolbarsManager.Tools collection). | |
Key | Overridden. Returns or sets a value that uniquely identifies an object in a collection. | |
KeyTipResolved | Returns the resolved value of the ToolPropsBase.KeyTip property on the SharedProps and InstanceProps objects. | |
MaxWidthResolved | Returns the resolved value of the ToolPropsBase.MaxWidth property on the SharedProps and InstanceProps objects. | |
MinimumSize | Returns the minimum size of the tool (read-only). | |
MinWidthResolved | Returns the resolved value of the ToolPropsBase.MinWidth property on the SharedProps and InstanceProps objects. | |
Owner | Returns the UltraToolbar, PopupMenuTool or UltraToolbarsManager that owns this tool instance. | |
OwnerIsApplicationMenu2010ContentArea | Returns a value indicating whether the tool type is on the content area of the ApplicationMenu2010 (not including the Navigation Menu area). | |
OwnerIsApplicationMenu2010NavigationMenu | Returns a value indicating whether the tool type supports being place in a NavigationMenu. | |
OwnerIsApplicationMenuArea | Returns a value indicating whether the tool type supports being place in a ApplicationMenu. | |
OwnerIsApplicationMenuAreaBase | Returns a value indicating whether the tool type supports being place in a ApplicationMenu or ApplicationMenu2010. | |
OwnerIsMenu | Returns true if this tool instance is owned by a PopupMenuTool. | |
OwnerIsNavigationToolbar | Returns true if this tool instance is owned by a NavigationToolbar. | |
OwnerIsNull | Returns true if this tool instance has not been fully initialized and has no owner. | |
OwnerIsRibbonGroup | Returns a value indicating whether the tool type supports being place in a Ribbon. | |
OwnerIsToolbar | Returns true if this tool instance is owned by a UltraToolbar. | |
OwnerIsToolbarBase | Returns true if this tool instance is owned by a UltraToolbarBase. | |
OwnerIsToolbarsManager | Returns true if this tool instance is owned by the UltraToolbarsManager. | |
OwningApplicationMenu2010NavigationMenu | Returns the owning NavigationMenu | |
OwningApplicationMenuArea | Returns the owning ApplicationMenuArea | |
OwningApplicationMenuAreaBase | Returns the owning ApplicationMenuAreaBase | |
OwningMenu | Returns the PopupMenuTool that owns this tool instance or null if this tool instance is not owned by a PopupMenuTool. | |
OwningNavigationToolbar | Returns the NavigationToolbar that owns this tool instance, or null if this instance is not owned by a NavigationToolbar. | |
OwningRibbonGroup | Returns the owning RibbonGroup | |
OwningToolbar | Returns the UltraToolbar that owns this tool instance or null if this tool instance is not owned by an UltraToolbar. | |
OwningToolbarBase | Returns the UltraToolbarBase that owns this tool instance or null if this tool instance is not owned by an UltraToolbarBase. | |
ParentCollection | The ToolsCollectionBase that owns this ToolBase. | |
RecentlyUsedResolved | Returns the resolved value of the InstanceProps.RecentlyUsed property, taking into account the tool's click activity and any customization performed by the end user. | |
SharedProps | Returns the SharedProps object which contains properties that are shared across all instances of the ToolBase. | |
ShortcutResolved | Returns the resolved value of the Shortcut property on the SharedProps object, taking into account any customization performed by the end user. | |
ShouldDisplayToolTip | Returns whether a ToolTip should be displayed for the ToolBase when the mouse hovers over it. | |
SpringResolved | Returns the resolved value of the Spring property on the SharedProps and InstanceProps objects. | |
Tag | (Inherited from Infragistics.Shared.SubObjectBase) | |
ToolbarsManager | The UltraToolbarsManager component that the ToolBase is owned by. | |
ToolTipTextFormattedResolved | Returns the value of the ToolTipTextFormatted property on the SharedProps object if it was set. | |
ToolTipTextResolved | Returns the value of the ToolTipText property on the SharedProps object if it was set. Otherwise, returns the value of CaptionResolved. | |
ToolTipTitleResolved | Returns the value of the ToolTipTitle property on the SharedProps object if it was set. | |
UIElement | Returns the UI Element for the ToolBase. | |
UIRoleForEditArea | Returns the UIRole for the edit area of this tool. | |
UIRoleOnMenus | Returns the UIRole of this tool when used on a menu. | |
UIRoleOnRibbonGroups | Returns the UIRole of this tool when used on a ribbon group. | |
UIRoleOnToolbars | Returns the UIRole of this tool when used on a toolbar. | |
UnderlyingTool | Returns the underlying tool that this tool points to. Used primarily for the MdiMergePlaceholderTool. | |
VisibleResolved | Returns the resolved value of the Visible property on the SharedProps and InstanceProps objects. | |
WidthResolved | Returns the resolved value of the ToolPropsBase.Width property on the SharedProps and InstanceProps objects. |
Name | Description | |
---|---|---|
DefaultAccessibleRole | The default accessible role for this type of tool. | |
DefaultAction | The default action for this type of tool. | |
ExtraSharedPropsCount | Returns the number of extra shared properties required by this class. | |
KeyLowercaseInterned | (Inherited from Infragistics.Shared.KeyedSubObjectBase) | |
PrimaryCollection | (Inherited from Infragistics.Shared.KeyedSubObjectBase) | |
SubObjectPropChangeHandler | (Inherited from Infragistics.Shared.SubObjectBase) |
Name | Description | |
---|---|---|
BringIntoView | Ensures that the ToolBase is currently in view. | |
CreateObjRef | Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. (Inherited from System.MarshalByRefObject) | |
Dispose | (Inherited from Infragistics.Shared.DisposableObject) | |
GetLifetimeService | Retrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from System.MarshalByRefObject) | |
InitializeLifetimeService | Obtains a lifetime service object to control the lifetime policy for this instance. (Inherited from System.MarshalByRefObject) | |
NotifyPropChange | Overloaded. (Inherited from Infragistics.Shared.SubObjectBase) | |
Reset | Resets all properties of the ToolBase to their default values. | |
ResetInstanceProps | Resets all InstanceProps properties to their default values. | |
ResetKey | (Inherited from Infragistics.Shared.KeyedSubObjectBase) | |
ResetSharedProps | Resets the SharedProps property to its default value. | |
ResetState | Resets the ToolBase to its original state undoing any changes that were made at runtime. | |
ResolveAppearance | Overloaded. Resolves the appearance for the tool. | |
ShouldSerializeKey | Overridden. Determines whether the Key property is set to its default value. | |
ShouldSerializeTag | (Inherited from Infragistics.Shared.SubObjectBase) | |
ToString | Returns the key value appended with the type name. | |
VerifyNotDisposed | (Inherited from Infragistics.Shared.DisposableObject) |
Name | Description | |
---|---|---|
CompareTo | Compares this tool to another. | |
CreateUIAutomationStub | Creates the UI Automation stub. | |
DeserializeTag | Overloaded. (Inherited from Infragistics.Shared.SubObjectBase) | |
DoDefaultAction | Performs the default action associated with this tool. | |
GetExtraSharedProps | Returns the object held in extra shared props at the specified index. | |
GetObjectData | Populates the specified System.Runtime.Serialization.SerializationInfo with the data from the object. | |
InitializeTag | (Inherited from Infragistics.Shared.SubObjectBase) | |
MemberwiseClone | Overloaded. Creates a shallow copy of the current System.MarshalByRefObject object. (Inherited from System.MarshalByRefObject) | |
Navigate | Navigates to another accessible object. | |
NotificationBadgeBounds | Determines the rectangle area of the NotificationUIElement. In this area the tools will display the element will be positioned based on its size and position Can be overridden in the other tools. | |
OnAddedToCollection | Overridden. Called when this object is being added to the specified collection. | |
OnDispose | Overridden. Called when disposed. | |
OnObjectPropChanged | (Inherited from Infragistics.Shared.SubObjectBase) | |
OnRemovedFromCollection | Overridden. Called when the object is being removed from the collection. | |
OnSubObjectPropChanged | Overridden. Called when a property has changed on a sub object. | |
ResetInternedKey | (Inherited from Infragistics.Shared.KeyedSubObjectBase) | |
ResetTag | (Inherited from Infragistics.Shared.SubObjectBase) | |
ResolveAppearancePhase | Performs a phase of a tool's appearance resolution process. | |
SerializeTag | Overloaded. (Inherited from Infragistics.Shared.SubObjectBase) | |
SetExtraSharedProps | Sets the object held in ExtraSharedProps at the specified index. | |
ShouldSerializeInstanceProps | Determines whether the InstanceProps property is set to its default value. | |
ShouldSerializeSharedProps | Determines whether the SharedProps property is set to its default value. |
Name | Description | |
---|---|---|
AfterToolActivate | Occurs after a tool becomes the active tool. | |
AfterToolCloseup | Occurs after a tool closes up. | |
AfterToolDeactivate | Occurs after a tool ceases to be the active tool. | |
AfterToolDropdown | Occurs after a tool drops down. | |
AfterToolEnterEditMode | Occurs after a tool has entered edit mode. | |
AfterToolExitEditMode | Occurs after a tool has exited edit mode. | |
BeforeToolActivate | Occurs before a tool becomes the active tool. | |
BeforeToolDropdown | Occurs before a tool drops down. | |
BeforeToolEnterEditMode | Cancelable event that occurs before a tool has entered edit mode. | |
BeforeToolExitEditMode | Cancelable event that occurs before a tool has exited edit mode. | |
SubObjectDisposed | (Inherited from Infragistics.Shared.SubObjectBase) | |
SubObjectPropChanged | (Inherited from Infragistics.Shared.SubObjectBase) | |
ToolClick | Occurs when the tool is clicked by the user. | |
ToolDoubleClick | Occurs when a tool is double-clicked by the user. | |
ToolEditError | Occurs after the BeforeToolExitEditMode event if the value that the user has entered is invalid. | |
ToolKeyDown | Occurs when a key is pressed when a tool has the input focus. | |
ToolKeyPress | Occurs when a key is pressed and released when a tool has the input focus. | |
ToolKeyUp | Occurs when a key is released when a tool has the input focus. | |
ToolValueChanged | Occurs when the value of a tool changes. |