Edit

IDesignerOptionService.SetOptionValue(String, String, Object) Method

  • Reference

Definition

Namespace:
System.ComponentModel.Design
Assembly:
System.ComponentModel.TypeConverter.dll
Assembly:
System.dll
Assembly:
netstandard.dll

Sets the value of the specified Windows Forms Designer option.

public:
 void SetOptionValue(System::String ^ pageName, System::String ^ valueName, System::Object ^ value);
public void SetOptionValue (string pageName, string valueName, object value);
abstract member SetOptionValue : string * string * obj -> unit
Public Sub SetOptionValue (pageName As String, valueName As String, value As Object)

Parameters

pageName
String

The name of the page that defines the option.

valueName
String

The name of the option property.

value
Object

The new value.

Remarks

The pageName parameter should consist of "WindowsFormsDesigner\CategoryName", where CategoryName is an options category name without any white space characters. The category name is typically "General". Therefore, you can access the "General" designer options category with the English page name "WindowsFormsDesigner\General".

Note

The page and value names are always expected in English. Therefore, the following table is provided to help you access the options you want.

The following table indicates the English value names, their data format, and a description of each:

Value Name Value Format Description
GridSize Size The size of each grid square.
GridSize.Width Int32 The width of each grid square. This nested property is read-only when accessed through the designer option service.
GridSize.Height Int32 The height of each grid square. This nested property is read-only when accessed through the designer option service.
ShowGrid Boolean true if the grid should be shown; false if the grid should not be shown.
SnapToGrid Boolean true if the positions of the components should be aligned to the grid; false if the positions should not necessarily be aligned.
LayoutMode Microsoft.VisualStudio.Windows.Forms.LayoutMode SnapLines to use snaplines, or SnapToGrid to align controls to the grid,
ObjectBoundSmartTagAutoShow Boolean true to allow a component's smart tag panel to open automatically upon creation; otherwise, false.
AutoToolboxPopulate Boolean true to automatically add a solution's custom controls and components to the Toolbox; otherwise, false.
UseOptimizedCodeGeneration Boolean true if the component cache is enabled; otherwise, false.

Applies to

See also