Version

ToolBase Class Members

The following tables list the members exposed by ToolBase.

Protected Fields
 NameDescription
Protected FieldtagValue (Inherited from Infragistics.Shared.SubObjectBase)
Public Properties
 NameDescription
Public PropertyAccessibilityObjectReturns the System.Windows.Forms.AccessibleObject for this tool.  
Public PropertyAccessibleRoleResolvedReturns the accessible role for this tool.  
Public PropertyAllowMultipleInstancesResolvedReturns the value of the AllowMultipleInstances property on the SharedProps object of the UnderlyingTool.  
Public PropertyBoundsGets the location and size of the tool in screen coordinates.  
Public PropertyCanActivateReturns whether the ToolBase can become the active ToolBase.  
Public PropertyCaptionResolvedReturns the resolved value of the ToolPropsBase.Caption property on the SharedProps and InstanceProps objects, taking into account any customization performed by the end user.  
Public PropertyComponentRoleReturns the ComponentRole of the UltraToolbarsManager  
Public PropertyControlReturns the Control attached to the tool (read-only).  
Public PropertyCustomizedCaptionReturns or sets the value of any user customization of the ToolPropsBase.Caption property.  
Public PropertyCustomizedDisplayStyleReturns or sets the value of any user customization of the ToolPropsBase.DisplayStyle property.  
Public PropertyCustomizedImageReturns or sets the value of any user customization of the Image displayed by the tool.  
Public PropertyCustomizedIsFirstInGroupReturns or sets the value of any user customization of the InstanceProps.IsFirstInGroup property.  
Public PropertyCustomizedRecentlyUsedReturns or sets the value of any user customization of the InstanceProps.RecentlyUsed property.  
Public PropertyCustomizedVisibleReturns the value of any user customization of the visibility of the tool.  
Public PropertyCustomizerCaptionResolvedReturns the string that will appear in the Customize dialog's 'Commands' list.  
Public PropertyCustomizerDescriptionResolvedReturns the resolved value of the CustomizerDescription property on the SharedProps object of the UnderlyingTool.  
Public PropertyDefaultSizeReturns the default size of the tool (read-only).  
Public PropertyDisplayStyleResolvedReturns the resolved value of the ToolPropsBase.DisplayStyle property on the SharedProps and InstanceProps objects, taking into account any customization performed by the end user.  
Public PropertyDisposed (Inherited from Infragistics.Shared.DisposableObject)
Public PropertyEnabledResolvedReturns whether the tool is enabled. It resolves the value based on the SharedProps's Enabled and UltraToolbarsManager's Enabled properties.  
Public PropertyHeightReturns the height of this instance of the tool.  
Public PropertyIndexReturns the index of the tool in the ToolsCollectionBase. This property is read-only.  
Public PropertyInstanceDisplaysImageReturns whether this tool instance displays its image.  
Public PropertyInstanceDisplaysTextReturns whether this tool instance displays its text.  
Public PropertyInstancePropsReturns the InstanceProps object which contains properties that are unique to a ToolBase instance.  
Public PropertyIsActiveToolReturns or sets whether this ToolBase is the active ToolBase.  
Public PropertyIsControlContainerReturns whether the tool is a container tool that can contain other controls. This property is read-only.  
Public PropertyIsFirstInGroupResolvedReturns the resolved value of the InstanceProps.IsFirstInGroup property, taking into account any customization performed by the end user.  
Public PropertyIsPopularCommandReturns whether this ToolBase is a PopularCommand  
Public PropertyIsRootToolReturns whether the ToolBase is a root ToolBase (i.e., is in the UltraToolbarsManager component's UltraToolbarsManager.Tools collection).  
Public PropertyKeyOverridden. Returns or sets a value that uniquely identifies an object in a collection.  
Public PropertyKeyTipResolvedReturns the resolved value of the ToolPropsBase.KeyTip property on the SharedProps and InstanceProps objects.  
Public PropertyMaxWidthResolvedReturns the resolved value of the ToolPropsBase.MaxWidth property on the SharedProps and InstanceProps objects.  
Public PropertyMinimumSizeReturns the minimum size of the tool (read-only).  
Public PropertyMinWidthResolvedReturns the resolved value of the ToolPropsBase.MinWidth property on the SharedProps and InstanceProps objects.  
Public PropertyOwnerReturns the UltraToolbar, PopupMenuTool or UltraToolbarsManager that owns this tool instance.  
Public PropertyOwnerIsApplicationMenu2010ContentAreaReturns a value indicating whether the tool type is on the content area of the ApplicationMenu2010 (not including the Navigation Menu area).  
Public PropertyOwnerIsApplicationMenu2010NavigationMenuReturns a value indicating whether the tool type supports being place in a NavigationMenu.  
Public PropertyOwnerIsApplicationMenuAreaReturns a value indicating whether the tool type supports being place in a ApplicationMenu.  
Public PropertyOwnerIsApplicationMenuAreaBaseReturns a value indicating whether the tool type supports being place in a ApplicationMenu or ApplicationMenu2010.  
Public PropertyOwnerIsMenuReturns true if this tool instance is owned by a PopupMenuTool.  
Public PropertyOwnerIsNavigationToolbarReturns true if this tool instance is owned by a NavigationToolbar.  
Public PropertyOwnerIsNullReturns true if this tool instance has not been fully initialized and has no owner.  
Public PropertyOwnerIsRibbonGroupReturns a value indicating whether the tool type supports being place in a Ribbon.  
Public PropertyOwnerIsToolbarReturns true if this tool instance is owned by a UltraToolbar.  
Public PropertyOwnerIsToolbarBaseReturns true if this tool instance is owned by a UltraToolbarBase.  
Public PropertyOwnerIsToolbarsManagerReturns true if this tool instance is owned by the UltraToolbarsManager.  
Public PropertyOwningApplicationMenu2010NavigationMenuReturns the owning NavigationMenu  
Public PropertyOwningApplicationMenuAreaReturns the owning ApplicationMenuArea  
Public PropertyOwningApplicationMenuAreaBaseReturns the owning ApplicationMenuAreaBase  
Public PropertyOwningMenuReturns the PopupMenuTool that owns this tool instance or null if this tool instance is not owned by a PopupMenuTool.  
Public PropertyOwningNavigationToolbarReturns the NavigationToolbar that owns this tool instance, or null if this instance is not owned by a NavigationToolbar.  
Public PropertyOwningRibbonGroupReturns the owning RibbonGroup  
Public PropertyOwningToolbarReturns the UltraToolbar that owns this tool instance or null if this tool instance is not owned by an UltraToolbar.  
Public PropertyOwningToolbarBaseReturns the UltraToolbarBase that owns this tool instance or null if this tool instance is not owned by an UltraToolbarBase.  
Public PropertyParentCollectionThe ToolsCollectionBase that owns this ToolBase.  
Public PropertyRecentlyUsedResolvedReturns the resolved value of the InstanceProps.RecentlyUsed property, taking into account the tool's click activity and any customization performed by the end user.  
Public PropertySharedPropsReturns the SharedProps object which contains properties that are shared across all instances of the ToolBase.  
Public PropertyShortcutResolvedReturns the resolved value of the Shortcut property on the SharedProps object, taking into account any customization performed by the end user.  
Public PropertyShouldDisplayToolTipReturns whether a ToolTip should be displayed for the ToolBase when the mouse hovers over it.  
Public PropertySpringResolvedReturns the resolved value of the Spring property on the SharedProps and InstanceProps objects.  
Public PropertyTag (Inherited from Infragistics.Shared.SubObjectBase)
Public PropertyToolbarsManagerThe UltraToolbarsManager component that the ToolBase is owned by.  
Public PropertyToolTipTextFormattedResolvedReturns the value of the ToolTipTextFormatted property on the SharedProps object if it was set.  
Public PropertyToolTipTextResolvedReturns the value of the ToolTipText property on the SharedProps object if it was set. Otherwise, returns the value of CaptionResolved.  
Public PropertyToolTipTitleResolvedReturns the value of the ToolTipTitle property on the SharedProps object if it was set.  
Public PropertyUIElementReturns the UI Element for the ToolBase.  
Public PropertyUIRoleForEditAreaReturns the UIRole for the edit area of this tool.  
Public PropertyUIRoleOnMenusReturns the UIRole of this tool when used on a menu.  
Public PropertyUIRoleOnRibbonGroupsReturns the UIRole of this tool when used on a ribbon group.  
Public PropertyUIRoleOnToolbarsReturns the UIRole of this tool when used on a toolbar.  
Public PropertyUnderlyingToolReturns the underlying tool that this tool points to. Used primarily for the MdiMergePlaceholderTool.  
Public PropertyVisibleResolvedReturns the resolved value of the Visible property on the SharedProps and InstanceProps objects.  
Public PropertyWidthResolvedReturns the resolved value of the ToolPropsBase.Width property on the SharedProps and InstanceProps objects.  
Protected Properties
 NameDescription
Protected PropertyDefaultAccessibleRoleThe default accessible role for this type of tool.  
Protected PropertyDefaultActionThe default action for this type of tool.  
Protected PropertyExtraSharedPropsCountReturns the number of extra shared properties required by this class.  
Protected PropertyKeyLowercaseInterned (Inherited from Infragistics.Shared.KeyedSubObjectBase)
Protected PropertyPrimaryCollection (Inherited from Infragistics.Shared.KeyedSubObjectBase)
Protected PropertySubObjectPropChangeHandler (Inherited from Infragistics.Shared.SubObjectBase)
Public Methods
 NameDescription
Public MethodBringIntoViewEnsures that the ToolBase is currently in view.  
Public MethodCreateObjRefCreates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. (Inherited from System.MarshalByRefObject)
Public MethodDispose (Inherited from Infragistics.Shared.DisposableObject)
Public MethodGetLifetimeServiceRetrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from System.MarshalByRefObject)
Public MethodInitializeLifetimeServiceObtains a lifetime service object to control the lifetime policy for this instance. (Inherited from System.MarshalByRefObject)
Public MethodNotifyPropChangeOverloaded.  (Inherited from Infragistics.Shared.SubObjectBase)
Public MethodResetResets all properties of the ToolBase to their default values.  
Public MethodResetInstancePropsResets all InstanceProps properties to their default values.  
Public MethodResetKey (Inherited from Infragistics.Shared.KeyedSubObjectBase)
Public MethodResetSharedPropsResets the SharedProps property to its default value.  
Public MethodResetStateResets the ToolBase to its original state undoing any changes that were made at runtime.  
Public MethodResolveAppearanceOverloaded. Resolves the appearance for the tool.  
Public MethodShouldSerializeKeyOverridden. Determines whether the Key property is set to its default value.  
Public MethodShouldSerializeTag (Inherited from Infragistics.Shared.SubObjectBase)
Public MethodToStringReturns the key value appended with the type name.  
Public MethodVerifyNotDisposed (Inherited from Infragistics.Shared.DisposableObject)
Protected Methods
 NameDescription
Protected MethodCompareToCompares this tool to another.  
Protected MethodCreateUIAutomationStubCreates the UI Automation stub.  
Protected MethodDeserializeTagOverloaded.  (Inherited from Infragistics.Shared.SubObjectBase)
Protected MethodDoDefaultActionPerforms the default action associated with this tool.  
Protected MethodGetExtraSharedPropsReturns the object held in extra shared props at the specified index.  
Protected MethodGetObjectDataPopulates the specified System.Runtime.Serialization.SerializationInfo with the data from the object.  
Protected MethodInitializeTag (Inherited from Infragistics.Shared.SubObjectBase)
Protected MethodMemberwiseCloneOverloaded. Creates a shallow copy of the current System.MarshalByRefObject object. (Inherited from System.MarshalByRefObject)
Protected MethodNavigateNavigates to another accessible object.  
Protected MethodNotificationBadgeBoundsDetermines 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.  
Protected MethodOnAddedToCollectionOverridden. Called when this object is being added to the specified collection.  
Protected MethodOnDisposeOverridden. Called when disposed.  
Protected MethodOnObjectPropChanged (Inherited from Infragistics.Shared.SubObjectBase)
Protected MethodOnRemovedFromCollectionOverridden. Called when the object is being removed from the collection.  
Protected MethodOnSubObjectPropChangedOverridden. Called when a property has changed on a sub object.  
Protected MethodResetInternedKey (Inherited from Infragistics.Shared.KeyedSubObjectBase)
Protected MethodResetTag (Inherited from Infragistics.Shared.SubObjectBase)
Protected MethodResolveAppearancePhasePerforms a phase of a tool's appearance resolution process.  
Protected MethodSerializeTagOverloaded.  (Inherited from Infragistics.Shared.SubObjectBase)
Protected MethodSetExtraSharedPropsSets the object held in ExtraSharedProps at the specified index.  
Protected MethodShouldSerializeInstancePropsDetermines whether the InstanceProps property is set to its default value.  
Protected MethodShouldSerializeSharedPropsDetermines whether the SharedProps property is set to its default value.  
Public Events
 NameDescription
Public EventAfterToolActivateOccurs after a tool becomes the active tool.  
Public EventAfterToolCloseupOccurs after a tool closes up.  
Public EventAfterToolDeactivateOccurs after a tool ceases to be the active tool.  
Public EventAfterToolDropdownOccurs after a tool drops down.  
Public EventAfterToolEnterEditModeOccurs after a tool has entered edit mode.  
Public EventAfterToolExitEditModeOccurs after a tool has exited edit mode.  
Public EventBeforeToolActivateOccurs before a tool becomes the active tool.  
Public EventBeforeToolDropdownOccurs before a tool drops down.  
Public EventBeforeToolEnterEditModeCancelable event that occurs before a tool has entered edit mode.  
Public EventBeforeToolExitEditModeCancelable event that occurs before a tool has exited edit mode.  
Public EventSubObjectDisposed (Inherited from Infragistics.Shared.SubObjectBase)
Public EventSubObjectPropChanged (Inherited from Infragistics.Shared.SubObjectBase)
Public EventToolClickOccurs when the tool is clicked by the user.  
Public EventToolDoubleClickOccurs when a tool is double-clicked by the user.  
Public EventToolEditErrorOccurs after the BeforeToolExitEditMode event if the value that the user has entered is invalid.  
Public EventToolKeyDownOccurs when a key is pressed when a tool has the input focus.  
Public EventToolKeyPressOccurs when a key is pressed and released when a tool has the input focus.  
Public EventToolKeyUpOccurs when a key is released when a tool has the input focus.  
Public EventToolValueChangedOccurs when the value of a tool changes.  
See Also