Export (0) Print
Expand All

DesignerAutoFormatCollection Class

Represents a collection of DesignerAutoFormat objects within a control designer. This class cannot be inherited.

System.Object
  System.Web.UI.Design.DesignerAutoFormatCollection

Namespace:  System.Web.UI.Design
Assembly:  System.Design (in System.Design.dll)

public sealed class DesignerAutoFormatCollection : IList, 
	ICollection, IEnumerable

The DesignerAutoFormatCollection type exposes the following members.

  NameDescription
Public methodDesignerAutoFormatCollectionInitializes a new instance of the DesignerAutoFormatCollection class.
Top

  NameDescription
Public propertyCountGets the number of DesignerAutoFormat objects in the collection.
Public propertyItemGets or sets a DesignerAutoFormat object at the specified index in the collection.
Public propertyPreviewSizeGets the maximum outer dimensions of the control as it will appear at run time.
Public propertySyncRootGets an object that can be used to synchronize access to the DesignerAutoFormatCollection object.
Top

  NameDescription
Public methodAddAdds the specified DesignerAutoFormat object to the end of the collection.
Public methodClearRemoves all formats from the collection.
Public methodContainsDetermines whether the specified format is contained within the collection.
Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodIndexOfReturns the index of the specified DesignerAutoFormat object within the collection.
Public methodInsertInserts a DesignerAutoFormat object into the collection at the specified index.
Public methodRemoveRemoves the specified DesignerAutoFormat object from the collection.
Public methodRemoveAtRemoves the DesignerAutoFormat object at the specified index within the collection.
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

  NameDescription
Public Extension MethodAsParallelEnables parallelization of a query. (Defined by ParallelEnumerable.)
Public Extension MethodAsQueryableConverts an IEnumerable to an IQueryable. (Defined by Queryable.)
Public Extension MethodCast<TResult>Casts the elements of an IEnumerable to the specified type. (Defined by Enumerable.)
Public Extension MethodOfType<TResult>Filters the elements of an IEnumerable based on a specified type. (Defined by Enumerable.)
Top

  NameDescription
Explicit interface implemetationPrivate methodICollection.CopyToInfrastructure. Copies the elements of the collection to an Array object, starting at a particular Array index when the DesignerAutoFormatCollection object is cast to an ICollection interface.
Explicit interface implemetationPrivate propertyICollection.CountInfrastructure. Gets the number of elements that are contained in the collection when the DesignerAutoFormatCollection object is cast to an ICollection interface.
Explicit interface implemetationPrivate propertyICollection.IsSynchronizedInfrastructure. Gets a value that indicates whether access to the collection is synchronized (thread safe) when the DesignerAutoFormatCollection object is cast to an ICollection interface.
Explicit interface implemetationPrivate methodIEnumerable.GetEnumeratorInfrastructure. Returns an IEnumerator interface that iterates through the collection when the DesignerAutoFormatCollection object is cast to an IEnumerable interface.
Explicit interface implemetationPrivate methodIList.AddInfrastructure. Adds an item to the collection when the DesignerAutoFormatCollection object is cast to an IList interface.
Explicit interface implemetationPrivate methodIList.ContainsInfrastructure. Determines whether the collection contains a specific value when the DesignerAutoFormatCollection object is cast to an IList interface.
Explicit interface implemetationPrivate methodIList.IndexOfInfrastructure. Determines the index of a specific item in the collection when the DesignerAutoFormatCollection object is cast to an IList interface.
Explicit interface implemetationPrivate methodIList.InsertInfrastructure. Inserts an item into the collection at the specified index when the DesignerAutoFormatCollection object is cast to an IList interface.
Explicit interface implemetationPrivate propertyIList.IsFixedSizeInfrastructure. Gets a value that indicates whether the collection has a fixed size when the DesignerAutoFormatCollection object is cast to an IList interface.
Explicit interface implemetationPrivate propertyIList.IsReadOnlyInfrastructure. For a description of this method, see IsReadOnly.
Explicit interface implemetationPrivate propertyIList.ItemInfrastructure. Gets the element at the specified index when the DesignerAutoFormatCollection object is cast to an IList interface.
Explicit interface implemetationPrivate methodIList.RemoveInfrastructure. Removes the first occurrence of a specific object from the collection when the DesignerAutoFormatCollection object is cast to an IList interface.
Explicit interface implemetationPrivate methodIList.RemoveAtInfrastructure. Removes the item at the specified index when the DesignerAutoFormatCollection object is cast to an IList interface.
Top

The ControlDesigner class and any derived class defines the AutoFormats property as a DesignerAutoFormatCollection object. Control developers can override the AutoFormats property in a derived control designer, add custom automatic formatting styles, and return the collection of supported formats to the visual designer.

The collection dynamically increases as objects are added. Indexes in this collection are zero-based. Use the Count property to determine how many automatic style formats are in the collection.

Additionally, use the DesignerAutoFormatCollection methods and properties to provide the following functionality:

  • The Add method to add a single format to the collection.

  • The Insert method to add a format at a particular index within the collection.

  • The Remove method to remove a format.

  • The RemoveAt method to remove the format at a particular index.

  • The Contains method to determine whether a particular format is already in the collection.

  • The IndexOf method to retrieve the index of a format within the collection.

  • The Item property to get or set the format at a particular index, using array notation.

  • The Clear method to remove all formats from the collection.

  • The Count property to determine the number of formats in the collection.

  • The IndexOf method to get the position of a format within the collection.

The following code example demonstrates how to implement the AutoFormats property in a custom control designer. The derived control designer implements the AutoFormats property by adding three instances of a custom automatic format that are derived from the DesignerAutoFormat class.

using System;
using System.Drawing;
using System.Collections;
using System.ComponentModel;
using System.Web.UI;
using System.Web.UI.Design;
using System.Web.UI.Design.WebControls;
using System.Web.UI.WebControls;

namespace CustomControls.Design.CS
{
	// A custom Label control whose contents can be indented
    [Designer(typeof(IndentLabelDesigner)), 
        ToolboxData("<{0}:IndentLabel Runat=\"server\"></{0}:IndentLabel>")]
    public class IndentLabel : Label
    {
        private int _indent = 0;

        // Property to indent all text within the label
        [Category("Appearance"), DefaultValue(0), 
            PersistenceMode(PersistenceMode.Attribute)]
        public int Indent
        {
            get { return _indent; }
            set
            {
                _indent = value;
                // Get the number of pixels to indent 
                int ind = value * 8;

                //  Add the indent style to the control 
                if (ind > 0)
                    this.Style.Add(HtmlTextWriterStyle.MarginLeft, ind.ToString() + "px");
                else 
                    this.Style.Remove(HtmlTextWriterStyle.MarginLeft);
            }
        }
    }


	// A design-time ControlDesigner for the IndentLabel control
    [SupportsPreviewControl(true)]
    public class IndentLabelDesigner : LabelDesigner
    {
        private DesignerAutoFormatCollection _autoFormats = null;

		// The collection of AutoFormat objects for the IndentLabel object 
        public override DesignerAutoFormatCollection AutoFormats
        {
            get
            {
                if (_autoFormats == null)
                {
					// Create the collection
                    _autoFormats = new DesignerAutoFormatCollection();

					// Create and add each AutoFormat object
                    _autoFormats.Add(new IndentLabelAutoFormat("MyClassic"));
                    _autoFormats.Add(new IndentLabelAutoFormat("MyBright"));
                    _autoFormats.Add(new IndentLabelAutoFormat("Default"));
                }
                return _autoFormats;
            }
        }

	    // An AutoFormat object for the IndentLabel control 
        private class IndentLabelAutoFormat : DesignerAutoFormat
        {
		    public IndentLabelAutoFormat(string name) : base(name)
		    { }

		    // Applies styles based on the Name of the AutoFormat 
            public override void Apply(Control inLabel)
            {
                if (inLabel is IndentLabel)
                {
                    IndentLabel ctl = (IndentLabel)inLabel;

				    // Apply formatting according to the Name 
                    if (this.Name == "MyClassic")
                    {
					    // For MyClassic, apply style elements directly to the control
                        ctl.ForeColor = Color.Gray;
                        ctl.BackColor = Color.LightGray;
                        ctl.Font.Size = FontUnit.XSmall;
                        ctl.Font.Name = "Verdana,Geneva,Sans-Serif";
                    }
                    else if (this.Name == "MyBright")
                    {
					    // For MyBright, apply style elements to the Style property 
                        this.Style.ForeColor = Color.Maroon;
					    this.Style.BackColor = Color.Yellow;
					    this.Style.Font.Size = FontUnit.Medium;

					    // Merge the AutoFormat style with the control's style
					    ctl.MergeStyle(this.Style);
                    }
                    else
                    {
					    // For the Default format, apply style elements to the control
                        ctl.ForeColor = Color.Black;
                        ctl.BackColor = Color.Empty;
                        ctl.Font.Size = FontUnit.XSmall;
                    }
                }
            }
        }
    }
}

.NET Framework

Supported in: 4.5.2, 4.5.1, 4.5, 4, 3.5, 3.0, 2.0

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

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:
© 2014 Microsoft