223 lines
12 KiB
XML
223 lines
12 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<Type Name="DesignerOptionService" FullName="System.ComponentModel.Design.DesignerOptionService">
|
|
<TypeSignature Language="C#" Value="public abstract class DesignerOptionService : System.ComponentModel.Design.IDesignerOptionService" />
|
|
<TypeSignature Language="ILAsm" Value=".class public auto ansi abstract beforefieldinit DesignerOptionService extends System.Object implements class System.ComponentModel.Design.IDesignerOptionService" />
|
|
<AssemblyInfo>
|
|
<AssemblyName>System</AssemblyName>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<Base>
|
|
<BaseTypeName>System.Object</BaseTypeName>
|
|
</Base>
|
|
<Interfaces>
|
|
<Interface>
|
|
<InterfaceName>System.ComponentModel.Design.IDesignerOptionService</InterfaceName>
|
|
</Interface>
|
|
</Interfaces>
|
|
<Docs>
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>The <see cref="T:System.ComponentModel.Design.DesignerOptionService" /> class provides a collection of options. Each of these option collections has an indexer that enables it to be further filtered. Each option collection contains its own set of options, as well as a rollup of all of its child options. In the event of a naming conflict between properties, the outermost options object takes precedence. The following <ui>Tools | Options</ui> user interface (UI) structure shows how the outermost options object takes on greater importance:</para>
|
|
<para>
|
|
<ui>WindowsFormsDesigner | General</ui>
|
|
</para>
|
|
<list type="bullet">
|
|
<item>
|
|
<para>
|
|
<ui>SnapToGrid</ui>
|
|
</para>
|
|
</item>
|
|
<item>
|
|
<para>
|
|
<ui>ShowGrid</ui>
|
|
</para>
|
|
</item>
|
|
<item>
|
|
<para>
|
|
<ui>GridSize</ui>
|
|
</para>
|
|
</item>
|
|
</list>
|
|
<para>Given a <see cref="T:System.ComponentModel.Design.IDesignerOptionService" /> named service, to get to the value of the <see cref="P:System.Windows.Forms.Design.ParentControlDesigner.GridSize" /> property, you would make the following call:</para>
|
|
<para>code reference: IDesignerOptionServiceExample#2</para>
|
|
<para>This works, until you want to move <see cref="P:System.Windows.Forms.Design.ParentControlDesigner.GridSize" /> to another page. Also, <see cref="T:System.ComponentModel.Design.IDesignerOptionService" /> provides no discovery mechanism. If you do not know what string to pass in, the service cannot find the property value.</para>
|
|
<para>The <see cref="T:System.ComponentModel.Design.DesignerOptionService" /> class addresses these issues. You can query collections, and there is a type converter defined on the <see cref="T:System.ComponentModel.Design.DesignerOptionService.DesignerOptionCollection" /> object that marks the collection as expandable. With this type converter, you can pass the entire designer option service to a property window and visually inspect the service.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Provides a base class for getting and setting option values for a designer.</para>
|
|
</summary>
|
|
</Docs>
|
|
<Members>
|
|
<Member MemberName=".ctor">
|
|
<MemberSignature Language="C#" Value="protected DesignerOptionService ();" />
|
|
<MemberSignature Language="ILAsm" Value=".method familyorassemblyhidebysig specialname rtspecialname instance void .ctor() cil managed" />
|
|
<MemberType>Constructor</MemberType>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<Parameters />
|
|
<Docs>
|
|
<remarks>To be added.</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Initializes a new instance of the <see cref="T:System.ComponentModel.Design.DesignerOptionService" /> class. </para>
|
|
</summary>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="CreateOptionCollection">
|
|
<MemberSignature Language="C#" Value="protected System.ComponentModel.Design.DesignerOptionService.DesignerOptionCollection CreateOptionCollection (System.ComponentModel.Design.DesignerOptionService.DesignerOptionCollection parent, string name, object value);" />
|
|
<MemberSignature Language="ILAsm" Value=".method familyhidebysig instance class System.ComponentModel.Design.DesignerOptionService/DesignerOptionCollection CreateOptionCollection(class System.ComponentModel.Design.DesignerOptionService/DesignerOptionCollection parent, string name, object value) cil managed" />
|
|
<MemberType>Method</MemberType>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<ReturnValue>
|
|
<ReturnType>System.ComponentModel.Design.DesignerOptionService+DesignerOptionCollection</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="parent" Type="System.ComponentModel.Design.DesignerOptionService+DesignerOptionCollection" />
|
|
<Parameter Name="name" Type="System.String" />
|
|
<Parameter Name="value" Type="System.Object" />
|
|
</Parameters>
|
|
<Docs>
|
|
<param name="parent">To be added.</param>
|
|
<param name="name">To be added.</param>
|
|
<param name="value">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Options">
|
|
<MemberSignature Language="C#" Value="public System.ComponentModel.Design.DesignerOptionService.DesignerOptionCollection Options { get; }" />
|
|
<MemberSignature Language="ILAsm" Value=".property instance class System.ComponentModel.Design.DesignerOptionService/DesignerOptionCollection Options" />
|
|
<MemberType>Property</MemberType>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<ReturnValue>
|
|
<ReturnType>System.ComponentModel.Design.DesignerOptionService+DesignerOptionCollection</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<value>To be added.</value>
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>There is always a global options collection that contains child collections.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Gets the options collection for this service.</para>
|
|
</summary>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="PopulateOptionCollection">
|
|
<MemberSignature Language="C#" Value="protected virtual void PopulateOptionCollection (System.ComponentModel.Design.DesignerOptionService.DesignerOptionCollection options);" />
|
|
<MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance void PopulateOptionCollection(class System.ComponentModel.Design.DesignerOptionService/DesignerOptionCollection options) cil managed" />
|
|
<MemberType>Method</MemberType>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="options" Type="System.ComponentModel.Design.DesignerOptionService+DesignerOptionCollection" />
|
|
</Parameters>
|
|
<Docs>
|
|
<param name="options">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<remarks>To be added.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="ShowDialog">
|
|
<MemberSignature Language="C#" Value="protected virtual bool ShowDialog (System.ComponentModel.Design.DesignerOptionService.DesignerOptionCollection options, object optionObject);" />
|
|
<MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance bool ShowDialog(class System.ComponentModel.Design.DesignerOptionService/DesignerOptionCollection options, object optionObject) cil managed" />
|
|
<MemberType>Method</MemberType>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<ReturnValue>
|
|
<ReturnType>System.Boolean</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="options" Type="System.ComponentModel.Design.DesignerOptionService+DesignerOptionCollection" />
|
|
<Parameter Name="optionObject" Type="System.Object" />
|
|
</Parameters>
|
|
<Docs>
|
|
<param name="options">To be added.</param>
|
|
<param name="optionObject">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="System.ComponentModel.Design.IDesignerOptionService.GetOptionValue">
|
|
<MemberSignature Language="C#" Value="object IDesignerOptionService.GetOptionValue (string pageName, string valueName);" />
|
|
<MemberSignature Language="ILAsm" Value=".method hidebysig newslot virtual instance object System.ComponentModel.Design.IDesignerOptionService.GetOptionValue(string pageName, string valueName) cil managed" />
|
|
<MemberType>Method</MemberType>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<ReturnValue>
|
|
<ReturnType>System.Object</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="pageName" Type="System.String" />
|
|
<Parameter Name="valueName" Type="System.String" />
|
|
</Parameters>
|
|
<Docs>
|
|
<remarks>To be added.</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Gets the value of an option defined in this package.</para>
|
|
</summary>
|
|
<returns>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>The value of the option named <paramref name="valueName" />.</para>
|
|
</returns>
|
|
<param name="pageName">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The page to which the option is bound.</param>
|
|
<param name="valueName">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The name of the option value.</param>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="System.ComponentModel.Design.IDesignerOptionService.SetOptionValue">
|
|
<MemberSignature Language="C#" Value="void IDesignerOptionService.SetOptionValue (string pageName, string valueName, object value);" />
|
|
<MemberSignature Language="ILAsm" Value=".method hidebysig newslot virtual instance void System.ComponentModel.Design.IDesignerOptionService.SetOptionValue(string pageName, string valueName, object value) cil managed" />
|
|
<MemberType>Method</MemberType>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="pageName" Type="System.String" />
|
|
<Parameter Name="valueName" Type="System.String" />
|
|
<Parameter Name="value" Type="System.Object" />
|
|
</Parameters>
|
|
<Docs>
|
|
<remarks>To be added.</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Sets the value of an option defined in this package.</para>
|
|
</summary>
|
|
<param name="pageName">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The page to which the option is bound</param>
|
|
<param name="valueName">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The name of the option value.</param>
|
|
<param name="value">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The value of the option.</param>
|
|
</Docs>
|
|
</Member>
|
|
</Members>
|
|
</Type> |