Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

IDesignerOptionService Interface

Provides access to the designer options located on the Tools menu under the Options command in the Visual Studio .NET development environment.

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

public interface IDesignerOptionService
public interface IDesignerOptionService
public interface IDesignerOptionService
Not applicable.

IDesignerOptionService provides an interface that can be used to retrieve and update the values of the Windows Forms Designer options, which are listed within the dialog displayed by the Options command of the Tools menu of the Visual Studio development environment. The GetOptionValue method retrieves the value of a specified option. The SetOptionValue method sets a specified value for a specified option.

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

using System;
using System.Collections;
using System.ComponentModel;
using System.ComponentModel.Design;
using System.Drawing;
using System.Data;
using System.Windows.Forms;
using System.Windows.Forms.Design;

namespace IDesignerOptionServiceExample
{
    // This control demonstrates retrieving the standard 
    // designer option service values in design mode.
    public class IDesignerOptionServiceControl : System.Windows.Forms.UserControl
    {		
        private IDesignerOptionService designerOptionService;

        public IDesignerOptionServiceControl()
        {
            this.BackColor = Color.Beige;
                    this.Size = new Size(404, 135);
        }
        
        public override System.ComponentModel.ISite Site
        {
            get
            {
                return base.Site;
            }
            set
            {
                base.Site = value;

                // If siting component, attempt to obtain an IDesignerOptionService.
                if( base.Site != null )                            
                    designerOptionService = (IDesignerOptionService)this.GetService(typeof(IDesignerOptionService));                                   
            }
        }

        // Displays control information and current IDesignerOptionService 
        // values, if available.
        protected override void OnPaint(System.Windows.Forms.PaintEventArgs e)
        {
            e.Graphics.DrawString("IDesignerOptionServiceControl", new Font("Arial", 9), new SolidBrush(Color.Blue), 4, 4);
            if( this.DesignMode )
                e.Graphics.DrawString("Currently in design mode", new Font("Arial", 8), new SolidBrush(Color.Black), 4, 18);
            else
                e.Graphics.DrawString("Not in design mode. Cannot access IDesignerOptionService.", new Font("Arial", 8), new SolidBrush(Color.Red), 4, 18);
            
            if( base.Site != null && designerOptionService != null )
            {
                e.Graphics.DrawString("IDesignerOptionService provides access to the table of option values listed when", new Font("Arial", 8), new SolidBrush(Color.Black), 4, 38);
                e.Graphics.DrawString("the Windows Forms Designer\\General tab of the Tools\\Options menu is selected.", new Font("Arial", 8), new SolidBrush(Color.Black), 4, 50);                
                
                e.Graphics.DrawString("Table of standard value names and current values", new Font("Arial", 8), new SolidBrush(Color.Red), 4, 76);
                
                // Displays a table of the standard value names and current values.
                int ypos = 90;

                // Obtains and shows the size of the standard design-mode grid square.
                Size size = (Size)designerOptionService.GetOptionValue("WindowsFormsDesigner\\General", "GridSize");
                e.Graphics.DrawString("GridSize", new Font("Arial", 8), new SolidBrush(Color.Black), 4, ypos);
                e.Graphics.DrawString(size.ToString(), new Font("Arial", 8), new SolidBrush(Color.Black), 100, ypos);
                ypos+=12;
                
                // Obtains and shows whether the design mode surface grid is enabled.
                bool showGrid = (bool)designerOptionService.GetOptionValue("WindowsFormsDesigner\\General", "ShowGrid");
                e.Graphics.DrawString("ShowGrid", new Font("Arial", 8), new SolidBrush(Color.Black), 4, ypos);
                e.Graphics.DrawString(showGrid.ToString(), new Font("Arial", 8), new SolidBrush(Color.Black), 100, ypos);
                ypos+=12;
                
                // Obtains and shows whether components should be aligned with the surface grid.
                bool snapToGrid = (bool)designerOptionService.GetOptionValue("WindowsFormsDesigner\\General", "SnapToGrid");
                e.Graphics.DrawString("SnapToGrid", new Font("Arial", 8), new SolidBrush(Color.Black), 4, ypos);
                e.Graphics.DrawString(snapToGrid.ToString(), new Font("Arial", 8), new SolidBrush(Color.Black), 100, ypos);                
            }
        }
    }
}

package IDesignerOptionServiceExample;

import System.*;
import System.Collections.*;
import System.ComponentModel.*;
import System.ComponentModel.Design.*;
import System.Drawing.*;
import System.Data.*;
import System.Windows.Forms.*;
import System.Windows.Forms.Design.*;

// This control demonstrates retrieving the standard 
// designer option service values in design mode.
public class IDesignerOptionServiceControl extends 
    System.Windows.Forms.UserControl
{
    private IDesignerOptionService designerOptionService;

    public IDesignerOptionServiceControl()
    {
        this.set_BackColor(Color.get_Beige());
        this.set_Size(new Size(404, 135));
    } //IDesignerOptionServiceControl

    /** @property 
     */
    public System.ComponentModel.ISite get_Site()
    {
        return super.get_Site();
    } //get_Site

    /** @property 
     */
    public void set_Site(System.ComponentModel.ISite value)
    {
        super.set_Site(value);
        // If siting component, attempt to obtain an IDesignerOptionService.
        if (super.get_Site() != null) {
            designerOptionService = ((IDesignerOptionService)
                (this.GetService(IDesignerOptionService.class.ToType())));
        }
    } //set_Site

    // Displays control information and current IDesignerOptionService 
    // values, if available.
    protected void OnPaint(System.Windows.Forms.PaintEventArgs e)
    {
        e.get_Graphics().DrawString("IDesignerOptionServiceControl", new 
            Font("Arial", 9), new SolidBrush(Color.get_Blue()), 4, 4);
        if (this.get_DesignMode()) {
            e.get_Graphics().DrawString("Currently in design mode", 
                new Font("Arial", 8), new SolidBrush(Color.get_Black()), 4, 18);
        }
        else {
            e.get_Graphics().DrawString("Not in design mode. Cannot access"
                + " IDesignerOptionService.", new Font("Arial", 8), 
                new SolidBrush(Color.get_Red()), 4, 18);
        }
        if (super.get_Site() != null && designerOptionService != null) {
            e.get_Graphics().DrawString("IDesignerOptionService provides "
                + " access to the table of option values listed when", 
                new Font("Arial", 8), new SolidBrush(Color.get_Black()),4,38);
            e.get_Graphics().DrawString("the Windows Forms Designer\\General"
                + " tab of the Tools\\Options menu is selected.", 
                new Font("Arial", 8), new SolidBrush(Color.get_Black()), 4, 50);
            e.get_Graphics().DrawString("Table of standard value names and "
                + " current values", new Font("Arial", 8), new SolidBrush(
                Color.get_Red()), 4, 76);
            // Displays a table of the standard value names and current values.
            int ypos = 90;

            // Obtains and shows the size of the standard design-mode 
            // grid square.
            Size size = ((Size)(designerOptionService.GetOptionValue(
                "WindowsFormsDesigner\\General", "GridSize")));
            e.get_Graphics().DrawString("GridSize", new Font("Arial", 8),
                new SolidBrush(Color.get_Black()), 4, ypos);
            e.get_Graphics().DrawString(size.ToString(), new Font("Arial", 8),
                new SolidBrush(Color.get_Black()), 100, ypos);
            ypos += 12;
            // Obtains and shows whether the design mode surface
            // grid is enabled.
            boolean showGrid = (System.Convert.ToBoolean((designerOptionService.
                GetOptionValue("WindowsFormsDesigner\\General", "ShowGrid"))));
            e.get_Graphics().DrawString("ShowGrid", new Font("Arial", 8), 
                new SolidBrush(Color.get_Black()), 4, ypos);
            e.get_Graphics().DrawString(System.Convert.ToString(showGrid), 
                new Font("Arial", 8), new SolidBrush(Color.get_Black()), 
                100, ypos);
            ypos += 12;

            // Obtains and shows whether components should be aligned with the
            // surface grid.
            boolean snapToGrid = System.Convert.ToBoolean(
                (designerOptionService.GetOptionValue(
                "WindowsFormsDesigner\\General", "SnapToGrid")));
            e.get_Graphics().DrawString("SnapToGrid", new Font("Arial", 8),
                new SolidBrush(Color.get_Black()), 4, ypos);
            e.get_Graphics().DrawString(System.Convert.ToString(snapToGrid),
                new Font("Arial", 8), new SolidBrush(Color.get_Black()), 
                100, ypos);
        }
    } //OnPaint
} //IDesignerOptionServiceControl

Windows 98, Windows Server 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0, 1.1, 1.0
Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.