IDesignerOptionService::SetOptionValue Method (String^, String^, Object^)

 

Sets the value of the specified Windows Forms Designer option.

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

void SetOptionValue(
	String^ pageName,
	String^ valueName,
	Object^ value
)

Parameters

pageName
Type: System::String^

The name of the page that defines the option.

valueName
Type: System::String^

The name of the option property.

value
Type: System::Object^

The new value.

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".

System_CAPS_noteNote

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.

.NET Framework
Available since 1.1
Return to top
Show: