Skip to content
Permalink
Branch: master
Find file Copy path
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
224 lines (216 sloc) 14.3 KB
<Type Name="PropertyValueUIItem" FullName="System.Drawing.Design.PropertyValueUIItem">
<TypeSignature Language="C#" Value="public class PropertyValueUIItem" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit PropertyValueUIItem extends System.Object" />
<TypeSignature Language="DocId" Value="T:System.Drawing.Design.PropertyValueUIItem" />
<TypeSignature Language="VB.NET" Value="Public Class PropertyValueUIItem" />
<TypeSignature Language="C++ CLI" Value="public ref class PropertyValueUIItem" />
<TypeSignature Language="F#" Value="type PropertyValueUIItem = class" />
<AssemblyInfo>
<AssemblyName>System.Drawing</AssemblyName>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>System.Windows.Forms</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>Provides information about a property displayed in the Properties window, including the associated event handler, pop-up information string, and the icon to display for the property.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Examples
The following code example provides a <xref:System.Drawing.Design.PropertyValueUIItem> object for any properties of the component named `HorizontalMargin` or `VerticalMargin`. The <xref:System.Drawing.Design.PropertyValueUIItem> for these properties provides an image, a ToolTip, and an event handler that displays a message box when the image for the property is clicked. This code example is part of a larger example provided for the <xref:System.Drawing.Design.IPropertyValueUIService> interface.
[!code-cpp[IPropertyValueUIServiceExample#2](~/samples/snippets/cpp/VS_Snippets_Winforms/IPropertyValueUIServiceExample/CPP/propertyuicomponent.cpp#2)]
[!code-csharp[IPropertyValueUIServiceExample#2](~/samples/snippets/csharp/VS_Snippets_Winforms/IPropertyValueUIServiceExample/CS/propertyuicomponent.cs#2)]
[!code-vb[IPropertyValueUIServiceExample#2](~/samples/snippets/visualbasic/VS_Snippets_Winforms/IPropertyValueUIServiceExample/VB/propertyuicomponent.vb#2)]
]]></format>
</remarks>
<permission cref="T:System.Security.NamedPermissionSet">for full access to system resources. Demand values: <see cref="F:System.Security.Permissions.SecurityAction.LinkDemand" />, <see cref="F:System.Security.Permissions.SecurityAction.InheritanceDemand" />. Associated state:</permission>
<altmember cref="T:System.Drawing.Design.IPropertyValueUIService" />
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public PropertyValueUIItem (System.Drawing.Image uiItemImage, System.Drawing.Design.PropertyValueUIItemInvokeHandler handler, string tooltip);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.Drawing.Image uiItemImage, class System.Drawing.Design.PropertyValueUIItemInvokeHandler handler, string tooltip) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Drawing.Design.PropertyValueUIItem.#ctor(System.Drawing.Image,System.Drawing.Design.PropertyValueUIItemInvokeHandler,System.String)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (uiItemImage As Image, handler As PropertyValueUIItemInvokeHandler, tooltip As String)" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; PropertyValueUIItem(System::Drawing::Image ^ uiItemImage, System::Drawing::Design::PropertyValueUIItemInvokeHandler ^ handler, System::String ^ tooltip);" />
<MemberSignature Language="F#" Value="new System.Drawing.Design.PropertyValueUIItem : System.Drawing.Image * System.Drawing.Design.PropertyValueUIItemInvokeHandler * string -&gt; System.Drawing.Design.PropertyValueUIItem" Usage="new System.Drawing.Design.PropertyValueUIItem (uiItemImage, handler, tooltip)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>System.Drawing</AssemblyName>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>System.Windows.Forms</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="uiItemImage" Type="System.Drawing.Image" />
<Parameter Name="handler" Type="System.Drawing.Design.PropertyValueUIItemInvokeHandler" />
<Parameter Name="tooltip" Type="System.String" />
</Parameters>
<Docs>
<param name="uiItemImage">The icon to display. The image must be 8 x 8 pixels.</param>
<param name="handler">The handler to invoke when the image is double-clicked.</param>
<param name="tooltip">The <see cref="P:System.Drawing.Design.PropertyValueUIItem.ToolTip" /> to display for the property that this <see cref="T:System.Drawing.Design.PropertyValueUIItem" /> is associated with.</param>
<summary>Initializes a new instance of the <see cref="T:System.Drawing.Design.PropertyValueUIItem" /> class.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Examples
The following code example provides a <xref:System.Drawing.Design.PropertyValueUIItem> object for any properties of the component named `HorizontalMargin` or `VerticalMargin`. The <xref:System.Drawing.Design.PropertyValueUIItem> for these properties provides an image, a ToolTip, and an event handler that displays a message box when the image for the property is clicked. This code example is part of a larger example provided for the <xref:System.Drawing.Design.IPropertyValueUIService> interface.
[!code-cpp[IPropertyValueUIServiceExample#2](~/samples/snippets/cpp/VS_Snippets_Winforms/IPropertyValueUIServiceExample/CPP/propertyuicomponent.cpp#2)]
[!code-csharp[IPropertyValueUIServiceExample#2](~/samples/snippets/csharp/VS_Snippets_Winforms/IPropertyValueUIServiceExample/CS/propertyuicomponent.cs#2)]
[!code-vb[IPropertyValueUIServiceExample#2](~/samples/snippets/visualbasic/VS_Snippets_Winforms/IPropertyValueUIServiceExample/VB/propertyuicomponent.vb#2)]
]]></format>
</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="uiItemImage" /> or <paramref name="handler" /> is <see langword="null" />.</exception>
<altmember cref="T:System.Drawing.Design.IPropertyValueUIService" />
<altmember cref="T:System.Drawing.Design.PropertyValueUIItemInvokeHandler" />
</Docs>
</Member>
<Member MemberName="Image">
<MemberSignature Language="C#" Value="public virtual System.Drawing.Image Image { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Drawing.Image Image" />
<MemberSignature Language="DocId" Value="P:System.Drawing.Design.PropertyValueUIItem.Image" />
<MemberSignature Language="VB.NET" Value="Public Overridable ReadOnly Property Image As Image" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; virtual property System::Drawing::Image ^ Image { System::Drawing::Image ^ get(); };" />
<MemberSignature Language="F#" Value="member this.Image : System.Drawing.Image" Usage="System.Drawing.Design.PropertyValueUIItem.Image" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Drawing</AssemblyName>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>System.Windows.Forms</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="netframework-4.0">
<AttributeName>get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Drawing.Image</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the 8 x 8 pixel image that will be drawn in the Properties window.</summary>
<value>The image to use for the property icon.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
This image must be 8 x 8 pixels. It is advisable to have the image support transparency.
]]></format>
</remarks>
<altmember cref="T:System.Drawing.Design.IPropertyValueUIService" />
</Docs>
</Member>
<Member MemberName="InvokeHandler">
<MemberSignature Language="C#" Value="public virtual System.Drawing.Design.PropertyValueUIItemInvokeHandler InvokeHandler { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Drawing.Design.PropertyValueUIItemInvokeHandler InvokeHandler" />
<MemberSignature Language="DocId" Value="P:System.Drawing.Design.PropertyValueUIItem.InvokeHandler" />
<MemberSignature Language="VB.NET" Value="Public Overridable ReadOnly Property InvokeHandler As PropertyValueUIItemInvokeHandler" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; virtual property System::Drawing::Design::PropertyValueUIItemInvokeHandler ^ InvokeHandler { System::Drawing::Design::PropertyValueUIItemInvokeHandler ^ get(); };" />
<MemberSignature Language="F#" Value="member this.InvokeHandler : System.Drawing.Design.PropertyValueUIItemInvokeHandler" Usage="System.Drawing.Design.PropertyValueUIItem.InvokeHandler" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Drawing</AssemblyName>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>System.Windows.Forms</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="netframework-4.0">
<AttributeName>get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Drawing.Design.PropertyValueUIItemInvokeHandler</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the handler that is raised when a user double-clicks this item.</summary>
<value>A <see cref="T:System.Drawing.Design.PropertyValueUIItemInvokeHandler" /> indicating the event handler for this user interface (UI) item.</value>
<remarks>To be added.</remarks>
<altmember cref="T:System.Drawing.Design.IPropertyValueUIService" />
<altmember cref="T:System.Drawing.Design.PropertyValueUIItemInvokeHandler" />
</Docs>
</Member>
<Member MemberName="Reset">
<MemberSignature Language="C#" Value="public virtual void Reset ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void Reset() cil managed" />
<MemberSignature Language="DocId" Value="M:System.Drawing.Design.PropertyValueUIItem.Reset" />
<MemberSignature Language="VB.NET" Value="Public Overridable Sub Reset ()" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; virtual void Reset();" />
<MemberSignature Language="F#" Value="abstract member Reset : unit -&gt; unit&#xA;override this.Reset : unit -&gt; unit" Usage="propertyValueUIItem.Reset " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Drawing</AssemblyName>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>System.Windows.Forms</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Resets the user interface (UI) item.</summary>
<remarks>To be added.</remarks>
<block subset="none" type="overrides">
<para>Derived classes can override this member to implement the redrawing of the UI item.</para>
</block>
</Docs>
</Member>
<Member MemberName="ToolTip">
<MemberSignature Language="C#" Value="public virtual string ToolTip { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string ToolTip" />
<MemberSignature Language="DocId" Value="P:System.Drawing.Design.PropertyValueUIItem.ToolTip" />
<MemberSignature Language="VB.NET" Value="Public Overridable ReadOnly Property ToolTip As String" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; virtual property System::String ^ ToolTip { System::String ^ get(); };" />
<MemberSignature Language="F#" Value="member this.ToolTip : string" Usage="System.Drawing.Design.PropertyValueUIItem.ToolTip" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Drawing</AssemblyName>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>System.Windows.Forms</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="netframework-4.0">
<AttributeName>get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the information string to display for this item.</summary>
<value>A string containing the information string to display for this item.</value>
<remarks>To be added.</remarks>
<altmember cref="T:System.Drawing.Design.IPropertyValueUIService" />
</Docs>
</Member>
</Members>
</Type>
You can’t perform that action at this time.