Infragistics logo
메뉴
.NET and JavaScript UI Controls
Version

SharedProps Class

Class which exposes properties that are shared among all instances of a ToolBase derived object.
Syntax
'Declaration
 
Public NotInheritable Class SharedProps 
   Inherits ToolPropsBase
public sealed class SharedProps : ToolPropsBase
Remarks

All tools in the same UltraToolbarsManager with the same Key and type will have the same SharedProps object. For example, setting the Caption on the SharedProps of a button tool with the key "Exit" in a file menu will change the caption of all button tools with the key "Exit" on all menus and toolbars.

The InstanceProps of a tool take precedence over the SharedProps. When resolving a property for a tool the value of the property on the InstanceProps will be checked first. If it is default, the value of the property on the SharedProps will be used. If that is also default, the most appropriate default value for the tool's type will be used.

Example
The following code demonstrates how to access some of the information passed in the event arguments of the ToolClick event.

Imports System.Diagnostics
Imports Infragistics.Win
Imports Infragistics.Win.UltraWinToolbars

	Private Sub UltraToolbarsManager1_ToolClick(ByVal sender As Object, ByVal e As Infragistics.Win.UltraWinToolbars.ToolClickEventArgs) Handles UltraToolbarsManager1.ToolClick

		Debug.WriteLine("The Tool with key '" + e.Tool.Key + "' has been clicked.  It is of type: '" + e.Tool.GetType().ToString() + "'")


		' Display property information for the tool that was clicked.
		Debug.IndentLevel += 1


		' Display all the properties of the tool's SharedProps object.
		Debug.WriteLine("SharedProps properties ------------------------------------------")


		' SharedProps.AllowMultipleInstances
		If e.Tool.SharedProps.AllowMultipleInstances = False Then
			Debug.WriteLine("Only one instance of this tool may be created!")
		End If

		Debug.WriteLine("Caption: '" + e.Tool.SharedProps.Caption)
		Debug.WriteLine("Tool has been assigned to category: '" + e.Tool.SharedProps.Category)
		Debug.WriteLine("The description that will be displayed for this tool in the runtime customizer is: '" + e.Tool.SharedProps.CustomizerCaption)
		Debug.WriteLine("DisplayStyle: '" + e.Tool.SharedProps.DisplayStyle.ToString())
		Debug.WriteLine("The enabled status for this tool is: '" + e.Tool.SharedProps.Enabled.ToString())
		Debug.WriteLine("MaxWidth: '" + e.Tool.SharedProps.MaxWidth.ToString())
		Debug.WriteLine("MinWidth: '" + e.Tool.SharedProps.MinWidth.ToString())
		Debug.WriteLine("The MergeOrder for this tool is: '" + e.Tool.SharedProps.MergeOrder.ToString())
		Debug.WriteLine("The MergeType for this tool is: '" + e.Tool.SharedProps.MergeType.ToString())
		Debug.WriteLine("The Priority for this tool when determining if it can be displayed on a toolbar with limited space is: '" + e.Tool.SharedProps.Priority.ToString())
		Debug.WriteLine("The Shortcut key combination associated with this tool is: '" + e.Tool.SharedProps.Shortcut.ToString())
		Debug.WriteLine("Spring: '" + e.Tool.SharedProps.Spring.ToString())
		Debug.WriteLine("Total # of instances of this tool: '" + e.Tool.SharedProps.ToolInstances.Count.ToString())
		Debug.WriteLine("ToolTipText: '" + e.Tool.SharedProps.ToolTipText.ToString())
		Debug.WriteLine("Visible: '" + e.Tool.SharedProps.Visible.ToString())
		Debug.WriteLine("Width: '" + e.Tool.SharedProps.Width.ToString())

		If e.Tool.SharedProps.ShowInCustomizer = False Then
			Debug.WriteLine("This tool will NOT be shown in the runtime customizer.")
		End If

		Debug.IndentLevel -= 1

	End Sub
using System.Diagnostics;
using Infragistics.Win;
using Infragistics.Win.UltraWinToolbars;

		private void ultraToolbarsManager1_ToolClick(object sender, Infragistics.Win.UltraWinToolbars.ToolClickEventArgs e)
		{

			Debug.WriteLine("The Tool with key '" + e.Tool.Key + "' has been clicked.  It is of type: '" + e.Tool.GetType().ToString() + "'");


			// Display property information for the tool that was clicked.
			Debug.IndentLevel++;


			// Display all the properties of the tool's SharedProps object.
			Debug.WriteLine("SharedProps properties ------------------------------------------");


			// SharedProps.AllowMultipleInstances
			if (e.Tool.SharedProps.AllowMultipleInstances == false)
				Debug.WriteLine("Only one instance of this tool may be created!");

			Debug.WriteLine("Caption: '" + e.Tool.SharedProps.Caption);
			Debug.WriteLine("Tool has been assigned to category: '" + e.Tool.SharedProps.Category);
			Debug.WriteLine("The description that will be displayed for this tool in the runtime customizer is: '" + e.Tool.SharedProps.CustomizerCaption);
			Debug.WriteLine("DisplayStyle: '" + e.Tool.SharedProps.DisplayStyle.ToString());
			Debug.WriteLine("The enabled status for this tool is: '" + e.Tool.SharedProps.Enabled.ToString());
			Debug.WriteLine("MaxWidth: '" + e.Tool.SharedProps.MaxWidth.ToString());
			Debug.WriteLine("MinWidth: '" + e.Tool.SharedProps.MinWidth.ToString());
			Debug.WriteLine("The MergeOrder for this tool is: '" + e.Tool.SharedProps.MergeOrder.ToString());
			Debug.WriteLine("The MergeType for this tool is: '" + e.Tool.SharedProps.MergeType.ToString());
			Debug.WriteLine("The Priority for this tool when determining if it can be displayed on a toolbar with limited space is: '" + e.Tool.SharedProps.Priority.ToString());
			Debug.WriteLine("The Shortcut key combination associated with this tool is: '" + e.Tool.SharedProps.Shortcut.ToString());
			Debug.WriteLine("Spring: '" + e.Tool.SharedProps.Spring.ToString());
			Debug.WriteLine("Total # of instances of this tool: '" + e.Tool.SharedProps.ToolInstances.Count.ToString());
			Debug.WriteLine("ToolTipText: '" + e.Tool.SharedProps.ToolTipText.ToString());
			Debug.WriteLine("Visible: '" + e.Tool.SharedProps.Visible.ToString());
			Debug.WriteLine("Width: '" + e.Tool.SharedProps.Width.ToString());

			if (e.Tool.SharedProps.ShowInCustomizer == false)
				Debug.WriteLine("This tool will NOT be shown in the runtime customizer.");


			Debug.IndentLevel--;

		}
Requirements

Target Platforms: Windows 10, Windows 8.1, Windows 8, Windows 7, Windows Server 2012, Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

See Also