Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
DesignerOptionService Class
Collapse the table of content
Expand the table of content

DesignerOptionService Class

Provides a base class for getting and setting option values for a designer.

Namespace:  System.ComponentModel.Design
Assembly:  System (in System.dll)

[<AbstractClass>]
[<HostProtectionAttribute(SecurityAction.LinkDemand, SharedState = true)>]
type DesignerOptionService =  
    class 
        interface IDesignerOptionService 
    end

The DesignerOptionService type exposes the following members.

  NameDescription
Protected methodDesignerOptionServiceInitializes a new instance of the DesignerOptionService class.
Top

  NameDescription
Public propertyOptionsGets the options collection for this service.
Top

  NameDescription
Protected methodCreateOptionCollectionCreates a new DesignerOptionService.DesignerOptionCollection with the given name and adds it to the given parent.
Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Protected methodPopulateOptionCollectionPopulates a DesignerOptionService.DesignerOptionCollection.
Protected methodShowDialogShows the options dialog box for the given object.
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

  NameDescription
Explicit interface implemetationPrivate methodIDesignerOptionService.GetOptionValueGets the value of an option defined in this package.
Explicit interface implemetationPrivate methodIDesignerOptionService.SetOptionValueSets the value of an option defined in this package.
Top

The 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 Tools | Options user interface (UI) structure shows how the outermost options object takes on greater importance:

WindowsFormsDesigner | General

  • SnapToGrid

  • ShowGrid

  • GridSize

Given a IDesignerOptionService named service, to get to the value of the GridSize property, you would make the following call:

No code example is currently available or this language may not be supported.

This works, until you want to move GridSize to another page. Also, IDesignerOptionService provides no discovery mechanism. If you do not know what string to pass in, the service cannot find the property value.

The DesignerOptionService class addresses these issues. You can query collections, and there is a type converter defined on the 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.

NoteNote

The HostProtectionAttribute attribute applied to this type or member has the following Resources property value: SharedState. The HostProtectionAttribute does not affect desktop applications (which are typically started by double-clicking an icon, typing a command, or entering a URL in a browser). For more information, see the HostProtectionAttribute class or SQL Server Programming and Host Protection Attributes.

The following code example demonstrates accessing the DesignerOptionService to display the current values of the standard options.

No code example is currently available or this language may not be supported.

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Show:
© 2015 Microsoft