IconDecorator Class

2013-11-24

DomainClass IconDecorator Defines a decorator that displays an icon or image.

Inheritance Hierarchy

System.Object
  Microsoft.VisualStudio.Modeling.ModelElement
    Microsoft.VisualStudio.Modeling.DslDefinition.DomainElement
      Microsoft.VisualStudio.Modeling.DslDefinition.Decorator
        Microsoft.VisualStudio.Modeling.DslDefinition.IconDecorator

Namespace: Microsoft.VisualStudio.Modeling.DslDefinition
Assembly: Microsoft.VisualStudio.Modeling.Sdk.DslDefinition.12.0 (in Microsoft.VisualStudio.Modeling.Sdk.DslDefinition.12.0.dll)

Syntax

'Declaration
<DisplayNameResourceAttribute("Microsoft.VisualStudio.Modeling.DslDefinition.IconDecorator.DisplayName",  _
    GetType(DslDefinitionModelDomainModel), "Microsoft.VisualStudio.Modeling.DslDefinition.GeneratedCode.DomainModelResx")> _
<DescriptionResourceAttribute("Microsoft.VisualStudio.Modeling.DslDefinition.IconDecorator.Description",  _
    GetType(DslDefinitionModelDomainModel), "Microsoft.VisualStudio.Modeling.DslDefinition.GeneratedCode.DomainModelResx")> _
<DomainModelOwnerAttribute(GetType(DslDefinitionModelDomainModel))> _
<CLSCompliantAttribute(True)> _
<DomainObjectIdAttribute("e1caa414-4d72-43f4-9c9f-4e8686625b77")> _
Public NotInheritable Class IconDecorator _
    Inherits Decorator

[DisplayNameResourceAttribute("Microsoft.VisualStudio.Modeling.DslDefinition.IconDecorator.DisplayName", 
    typeof(DslDefinitionModelDomainModel), "Microsoft.VisualStudio.Modeling.DslDefinition.GeneratedCode.DomainModelResx")]
[DescriptionResourceAttribute("Microsoft.VisualStudio.Modeling.DslDefinition.IconDecorator.Description", 
    typeof(DslDefinitionModelDomainModel), "Microsoft.VisualStudio.Modeling.DslDefinition.GeneratedCode.DomainModelResx")]
[DomainModelOwnerAttribute(typeof(DslDefinitionModelDomainModel))]
[CLSCompliantAttribute(true)]
[DomainObjectIdAttribute("e1caa414-4d72-43f4-9c9f-4e8686625b77")]
public sealed class IconDecorator : Decorator

[DisplayNameResourceAttribute(L"Microsoft.VisualStudio.Modeling.DslDefinition.IconDecorator.DisplayName", 
    typeof(DslDefinitionModelDomainModel), L"Microsoft.VisualStudio.Modeling.DslDefinition.GeneratedCode.DomainModelResx")]
[DescriptionResourceAttribute(L"Microsoft.VisualStudio.Modeling.DslDefinition.IconDecorator.Description", 
    typeof(DslDefinitionModelDomainModel), L"Microsoft.VisualStudio.Modeling.DslDefinition.GeneratedCode.DomainModelResx")]
[DomainModelOwnerAttribute(typeof(DslDefinitionModelDomainModel))]
[CLSCompliantAttribute(true)]
[DomainObjectIdAttribute(L"e1caa414-4d72-43f4-9c9f-4e8686625b77")]
public ref class IconDecorator sealed : public Decorator

[<Sealed>]
[<DisplayNameResourceAttribute("Microsoft.VisualStudio.Modeling.DslDefinition.IconDecorator.DisplayName", 
    typeof(DslDefinitionModelDomainModel), "Microsoft.VisualStudio.Modeling.DslDefinition.GeneratedCode.DomainModelResx")>]
[<DescriptionResourceAttribute("Microsoft.VisualStudio.Modeling.DslDefinition.IconDecorator.Description", 
    typeof(DslDefinitionModelDomainModel), "Microsoft.VisualStudio.Modeling.DslDefinition.GeneratedCode.DomainModelResx")>]
[<DomainModelOwnerAttribute(typeof(DslDefinitionModelDomainModel))>]
[<CLSCompliantAttribute(true)>]
[<DomainObjectIdAttribute("e1caa414-4d72-43f4-9c9f-4e8686625b77")>]
type IconDecorator =  
    class 
        inherit Decorator 
    end

public final class IconDecorator extends Decorator

The IconDecorator type exposes the following members.

Constructors

	Name	Description
	IconDecorator(Partition, array<PropertyAssignment[])	Constructor
	IconDecorator(Store, array<PropertyAssignment[])	Constructor

Top

Properties

	Name	Description
	DefaultIcon	Gets or sets the value of DefaultIcon domain property. Path to the icon or image file to be displayed by default.
	DiagramElement	Gets or sets DiagramElement. Diagram element to which the decorator belongs. (Inherited from Decorator.)
	DisplayName	Gets or sets the value of DisplayName domain property. The name that will be displayed in the generated designer for this decorator. (Inherited from Decorator.)
	Id	Gets the ID of the element. (Inherited from ModelElement.)
	IsActive	Gets the IsActive flag and verifies to see whether the element is active. (Inherited from ModelElement.)
	IsDeleted	Gets the IsDeleted flag and checks to see whether the element has been deleted from the model. (Inherited from ModelElement.)
	IsDeleting	Gets the IsDeleting flag and verifies whether the element is currently being deleted from the model. (Inherited from ModelElement.)
	IsDisplayNameTracking	Gets or sets the value of IsDisplayNameTracking domain property. If True, the Name property tracks other data in the DSL definition. (Inherited from Decorator.)
	Name	Gets or sets the value of Name domain property. Name of the decorator. (Inherited from Decorator.)
	Notes	Gets or sets the value of Notes domain property. Informal notes associated with this element. (Inherited from DomainElement.)
	Partition	Gets or sets the Partition that contains the element. (Inherited from ModelElement.)
	Store	Gets the Store that contains the element. (Inherited from ModelElement.)

Top

Methods

	Name	Description
	Copy()	Creates a copy of the element in the model. (Inherited from ModelElement.)
	Copy(IEnumerable<Guid>)	Creates a copy of the element and its child links and elements. (Inherited from ModelElement.)
	Delete()	Deletes an element from the model. (Inherited from ModelElement.)
	Delete(array<Guid[])	Deletes an element from the model. (Inherited from ModelElement.)
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	GetDomainClass	Gets the most-derived domain class for this element. (Inherited from ModelElement.)
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	OnCopy	Called when this element has been created as a copy of another element. (Inherited from ModelElement.)
	OnDeleted	Called when this element has been deleted from the model. (Inherited from ModelElement.)
	OnDeleting	Called when this element is about to be deleted. (Inherited from ModelElement.)
	OnResurrected	Called when this element has been added back to a model. (Inherited from ModelElement.)
	OnRolePlayerPositionChanged	Called when the position of a role has changed. (Inherited from ModelElement.)
	OnRolePlayerPositionChanging	Called when a role player position is about to change. (Inherited from ModelElement.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Extension Methods

	Name	Description
	AddExtension(Guid)	Overloaded. Extend this ModelElement with newly instantiated extension of the identified domain type. An InvalidOperationException will be thrown if the element already has an extension of that type. (Defined by ModelElementExtensionMethods.)
	AddExtension(Type)	Overloaded. Extend this ModelElement with a newly instantiated extension of the specified type. An InvalidOperationException will be thrown if the element already has an extension of that type. (Defined by ModelElementExtensionMethods.)
	AddExtension(DomainClassInfo)	Overloaded. Extend this ModelElement with a newly instantiated extension of the specified domain type. An InvalidOperationException will be thrown if the element already has an extension of that type. (Defined by ModelElementExtensionMethods.)
	AddExtension(ExtensionElement)	Overloaded. Extend this ModelElement with a specific extension. An InvalidOperationException will be thrown if the element already has an extension of the same type. (Defined by ModelElementExtensionMethods.)
	AddExtension<T>()	Overloaded. Extend this ModelElement with a newly instantiated extension of a particular type. An InvalidOperationException will be thrown if the element already has an extension of the same type. (Defined by ModelElementExtensionMethods.)
	CanDelete	Deletes the element from the model. (Defined by ImmutabilityExtensionMethods.)
	GetAllExtensions	Return an enumerable that performs a breadth first traversal across the tree of extension elements embedded in this ModelElement. (Defined by ModelElementExtensionMethods.)
	GetBaseElement	Returns the root of the virtual MEL in which the specified ModelElement is participating. (Defined by ModelElementExtensionMethods.)
	GetExtension(Guid)	Overloaded. (Defined by ModelElementExtensionMethods.)
	GetExtension(Type)	Overloaded. Get the ExtensionElement of the specified type from the available extensions of this ModelElement. If the element has no such extension then an InvalidOperationException will be raised. (Defined by ModelElementExtensionMethods.)
	GetExtension(DomainClassInfo)	Overloaded. (Defined by ModelElementExtensionMethods.)
	GetExtension<T>()	Overloaded. Get the ExtensionElement of the specified type from the available extensions of this ModelElement. If the element has no such extension then an InvalidOperationException will be raised. (Defined by ModelElementExtensionMethods.)
	GetLocks	Get the lock flags for this element. This will include any locks enabled on the Partition containing the element. (Defined by ImmutabilityExtensionMethods.)
	IsExtendedBy(Guid)	Overloaded. Query whether this ModelElement is currently extended by an ExtensionElement of a particular type. (Defined by ModelElementExtensionMethods.)
	IsExtendedBy(Type)	Overloaded. Query whether this ModelElement is currently extended by an ExtensionElement of a particular type. (Defined by ModelElementExtensionMethods.)
	IsExtendedBy(DomainClassInfo)	Overloaded. Query whether this ModelElement is currently extended by an ExtensionElement of a particular type. (Defined by ModelElementExtensionMethods.)
	IsLocked	Test whether this element has any of a specified set of locks (Defined by ImmutabilityExtensionMethods.)
	RemoveExtension(Type)	Overloaded. Remove any extension of this ModelElement that is of a particular type. (Defined by ModelElementExtensionMethods.)
	RemoveExtension(Guid)	Overloaded. Remove any extension of the specified ModelElement that is of a particular type. (Defined by ModelElementExtensionMethods.)
	RemoveExtension(DomainClassInfo)	Overloaded. Remove any extension of the specified ModelElement that is of a particular type. (Defined by ModelElementExtensionMethods.)
	RemoveExtension(ExtensionElement)	Overloaded. Remove a specified ExtensionElement from the extensions of this ModelElement. (Defined by ModelElementExtensionMethods.)
	SetLocks	Set the lock flags of this element (Defined by ImmutabilityExtensionMethods.)
	TryGetExtension(Guid)	Overloaded. (Defined by ModelElementExtensionMethods.)
	TryGetExtension(Type)	Overloaded. (Defined by ModelElementExtensionMethods.)
	TryGetExtension(DomainClassInfo)	Overloaded. (Defined by ModelElementExtensionMethods.)
	TryGetExtension<T>()	Overloaded. Get the ExtensionElement of the specified type from the available extensions of this ModelElement. If this element has no such extension then the result will be null. (Defined by ModelElementExtensionMethods.)

Top

Fields

	Name	Description
	DefaultIconDomainPropertyId	DefaultIcon domain property Id.
	DomainClassId	IconDecorator domain class Id.

Top

Explicit Interface Implementations

	Name	Description
	IMergeElements.CanMerge	Returns true if this element can merge with the content of the prototype. (Inherited from ModelElement.)
	IMergeElements.ChooseMergeTarget(ElementGroup)	(Inherited from ModelElement.)
	IMergeElements.ChooseMergeTarget(ElementGroupPrototype)	(Inherited from ModelElement.)
	IMergeElements.MergeConfigure	(Inherited from ModelElement.)
	IMergeElements.MergeDisconnect	(Inherited from ModelElement.)
	IMergeElements.MergeRelate	(Inherited from ModelElement.)

Top

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