GridCellLengthAttribute Class
This class associates a grid cell size with a MEF export.
Inheritance Hierarchy
Object
Attribute
Microsoft.VisualStudio.Utilities.SingletonBaseMetadataAttribute
Microsoft.VisualStudio.Text.Editor.GridCellLengthAttribute
Namespace: Microsoft.VisualStudio.Text.Editor
Assembly: Microsoft.VisualStudio.Text.UI.Wpf (in Microsoft.VisualStudio.Text.UI.Wpf.dll)
Syntax
'Declaration
<MetadataAttributeAttribute> _
<AttributeUsageAttribute(AttributeTargets.Class Or AttributeTargets.Method Or AttributeTargets.Property Or AttributeTargets.Field, AllowMultiple := False)> _
Public NotInheritable Class GridCellLengthAttribute _
Inherits SingletonBaseMetadataAttribute
[MetadataAttributeAttribute]
[AttributeUsageAttribute(AttributeTargets.Class|AttributeTargets.Method|AttributeTargets.Property|AttributeTargets.Field, AllowMultiple = false)]
public sealed class GridCellLengthAttribute : SingletonBaseMetadataAttribute
[MetadataAttributeAttribute]
[AttributeUsageAttribute(AttributeTargets::Class|AttributeTargets::Method|AttributeTargets::Property|AttributeTargets::Field, AllowMultiple = false)]
public ref class GridCellLengthAttribute sealed : public SingletonBaseMetadataAttribute
[<Sealed>]
[<MetadataAttributeAttribute>]
[<AttributeUsageAttribute(AttributeTargets.Class|AttributeTargets.Method|AttributeTargets.Property|AttributeTargets.Field, AllowMultiple = false)>]
type GridCellLengthAttribute =
class
inherit SingletonBaseMetadataAttribute
end
public final class GridCellLengthAttribute extends SingletonBaseMetadataAttribute
The GridCellLengthAttribute type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
.gif "Public method") |
GridCellLengthAttribute | Initializes a new instance of GridCellLengthAttribute. |
Top
Properties
| Name | Description | |
|---|---|---|
.gif "Public property") |
GridCellLength | Gets the length of the cell. |
|
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 | |
|---|---|---|
.gif "Explicit interface implemetation") .gif "Private method") |
System#Runtime#InteropServices#_Attribute#GetIDsOfNames | Maps a set of names to a corresponding set of dispatch identifiers. (Inherited from Attribute.) |
|
System#Runtime#InteropServices#_Attribute#GetTypeInfo | Retrieves the type information for an object, which can be used to get the type information for an interface. (Inherited from Attribute.) |
|
System#Runtime#InteropServices#_Attribute#GetTypeInfoCount | Retrieves the number of type information interfaces that an object provides (either 0 or 1). (Inherited from Attribute.) |
|
System#Runtime#InteropServices#_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 GridLength. This class is used in combination with GridUnitTypeAttribute to create a GridLength for a cell in a Grid.
Examples
[Export(typeof(IWpfTextViewMarginProvider))]
[Name(PredefinedMarginNames.VerticalScrollBar)]
[MarginContainer(PredefinedMarginNames.VerticalScrollBarContainerMargin)]
[ContentType("text")]
[TextViewRole(PredefinedTextViewRoles.Interactive)]
[GridUnitType(GridUnitType.Pixel)] //this size is expressed as a pixel using the GridCellLength attribute
[GridCellLength(15)] //15 pixels wide
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.