GridUnitTypeAttribute Class

Article
06/27/2014

This class associates a GridUnitType value with a MEF export.

Inheritance Hierarchy

System.Object
  System.Attribute
    Microsoft.VisualStudio.Utilities.SingletonBaseMetadataAttribute
      Microsoft.VisualStudio.Text.Editor.GridUnitTypeAttribute

Namespace: Microsoft.VisualStudio.Text.Editor
Assembly: Microsoft.VisualStudio.Text.UI.Wpf (in Microsoft.VisualStudio.Text.UI.Wpf.dll)

Syntax

'Declaration
<AttributeUsageAttribute(AttributeTargets.Class Or AttributeTargets.Method Or AttributeTargets.Property Or AttributeTargets.Field, AllowMultiple := False)> _
<MetadataAttributeAttribute> _
Public NotInheritable Class GridUnitTypeAttribute _
    Inherits SingletonBaseMetadataAttribute

[AttributeUsageAttribute(AttributeTargets.Class|AttributeTargets.Method|AttributeTargets.Property|AttributeTargets.Field, AllowMultiple = false)]
[MetadataAttributeAttribute]
public sealed class GridUnitTypeAttribute : SingletonBaseMetadataAttribute

[AttributeUsageAttribute(AttributeTargets::Class|AttributeTargets::Method|AttributeTargets::Property|AttributeTargets::Field, AllowMultiple = false)]
[MetadataAttributeAttribute]
public ref class GridUnitTypeAttribute sealed : public SingletonBaseMetadataAttribute

[<Sealed>]
[<AttributeUsageAttribute(AttributeTargets.Class|AttributeTargets.Method|AttributeTargets.Property|AttributeTargets.Field, AllowMultiple = false)>]
[<MetadataAttributeAttribute>]
type GridUnitTypeAttribute =  
    class 
        inherit SingletonBaseMetadataAttribute 
    end

public final class GridUnitTypeAttribute extends SingletonBaseMetadataAttribute

The GridUnitTypeAttribute type exposes the following members.

Constructors

	Name	Description
	GridUnitTypeAttribute	Initializes a new instance of GridUnitTypeAttribute.

Top

Properties

	Name	Description
	GridUnitType	Gets the grid unit type.
	TypeId	When implemented in a derived class, gets a unique identifier for this Attribute. (Inherited from Attribute.)

Top

Methods

	Name	Description
	Equals	Infrastructure. Returns a value that indicates whether this instance is equal to a specified object. (Inherited from Attribute.)
	GetHashCode	Returns the hash code for this instance. (Inherited from Attribute.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	IsDefaultAttribute	When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class. (Inherited from Attribute.)
	Match	When overridden in a derived class, returns a value that indicates whether this instance equals a specified object. (Inherited from Attribute.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Explicit Interface Implementations

	Name	Description
	_Attribute.GetIDsOfNames	Maps a set of names to a corresponding set of dispatch identifiers. (Inherited from Attribute.)
	_Attribute.GetTypeInfo	Retrieves the type information for an object, which can be used to get the type information for an interface. (Inherited from Attribute.)
	_Attribute.GetTypeInfoCount	Retrieves the number of type information interfaces that an object provides (either 0 or 1). (Inherited from Attribute.)
	_Attribute.Invoke	Provides access to properties and methods exposed by an object. (Inherited from Attribute.)

Top

Remarks

The value of this attribute is used by the consumers to decide rendering behavior for the exported object. The rendering behavior matches the behavior defined in WPF classes (e.g. Grid) that interact with GridUnitType.

Examples

[Export(typeof(IWpfTextViewMarginProvider))]
[Name(PredefinedMarginNames.VerticalScrollBar)]
[MarginContainer(PredefinedMarginNames.VerticalScrollBarContainerMargin)]
[ContentType("text")]
[TextViewRole(PredefinedTextViewRoles.Interactive)]
[GridUnitType(GridUnitType.Star)] //this size is determined as a weighted proportion of available space
internal sealed class VerticalScrollBarMarginProvider : IWpfTextViewMarginProvider 
{ */ implementation /* }

Thread Safety

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

Share via