Designer Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
DomainClass Designer Defines an editor with a graphical design surface.
public ref class Designer sealed : Microsoft::VisualStudio::Modeling::DslDefinition::Editor[Microsoft.VisualStudio.Modeling.Design.DescriptionResource("Microsoft.VisualStudio.Modeling.DslDefinition.Designer.Description", typeof(Microsoft.VisualStudio.Modeling.DslDefinition.DslDefinitionModelDomainModel), "Microsoft.VisualStudio.Modeling.DslDefinition.GeneratedCode.DomainModelResx")]
[Microsoft.VisualStudio.Modeling.Design.DisplayNameResource("Microsoft.VisualStudio.Modeling.DslDefinition.Designer.DisplayName", typeof(Microsoft.VisualStudio.Modeling.DslDefinition.DslDefinitionModelDomainModel), "Microsoft.VisualStudio.Modeling.DslDefinition.GeneratedCode.DomainModelResx")]
[Microsoft.VisualStudio.Modeling.DomainModelOwner(typeof(Microsoft.VisualStudio.Modeling.DslDefinition.DslDefinitionModelDomainModel))]
[Microsoft.VisualStudio.Modeling.DomainObjectId("546a0ae1-5442-40d6-b9b6-98833d4b6320")]
[Microsoft.VisualStudio.Modeling.Validation.ValidationState(Microsoft.VisualStudio.Modeling.Validation.ValidationState.Enabled)]
[System.CLSCompliant(true)]
public sealed class Designer : Microsoft.VisualStudio.Modeling.DslDefinition.Editor[<Microsoft.VisualStudio.Modeling.Design.DescriptionResource("Microsoft.VisualStudio.Modeling.DslDefinition.Designer.Description", typeof(Microsoft.VisualStudio.Modeling.DslDefinition.DslDefinitionModelDomainModel), "Microsoft.VisualStudio.Modeling.DslDefinition.GeneratedCode.DomainModelResx")>]
[<Microsoft.VisualStudio.Modeling.Design.DisplayNameResource("Microsoft.VisualStudio.Modeling.DslDefinition.Designer.DisplayName", typeof(Microsoft.VisualStudio.Modeling.DslDefinition.DslDefinitionModelDomainModel), "Microsoft.VisualStudio.Modeling.DslDefinition.GeneratedCode.DomainModelResx")>]
[<Microsoft.VisualStudio.Modeling.DomainModelOwner(typeof(Microsoft.VisualStudio.Modeling.DslDefinition.DslDefinitionModelDomainModel))>]
[<Microsoft.VisualStudio.Modeling.DomainObjectId("546a0ae1-5442-40d6-b9b6-98833d4b6320")>]
[<Microsoft.VisualStudio.Modeling.Validation.ValidationState(Microsoft.VisualStudio.Modeling.Validation.ValidationState.Enabled)>]
[<System.CLSCompliant(true)>]
type Designer = class
inherit EditorPublic NotInheritable Class Designer
Inherits Editor- Inheritance
- Attributes
Constructors
| Designer(Partition, PropertyAssignment[]) |
Constructor |
| Designer(Store, PropertyAssignment[]) |
Constructor |
Fields
| DomainClassId |
Designer domain class Id. |
| UsesStickyToolboxItemsDomainPropertyId |
UsesStickyToolboxItems domain property Id. |
Properties
| CopyPasteGeneration |
Gets or sets the value of CopyPasteGeneration domain property. Enable Cut/Copy/Paste in the generated designer. (Inherited from Editor) |
| Diagram |
Gets or sets Diagram. Diagram definition used for the designer. |
| Dsl |
Gets or sets Dsl. Dsl defining the editor. (Inherited from Editor) |
| EditorGuid |
Gets or sets the value of EditorGuid domain property. Guid for the editor. (Inherited from Editor) |
| FileExtension |
Gets or sets the value of FileExtension domain property. File extension registered for the editor. (Inherited from Editor) |
| Icon |
Gets or sets the value of Icon domain property. Icon associated with the editor. (Inherited from Editor) |
| Id |
Unique identifier of this element. (Inherited from ModelElement) |
| IsActive |
Returns true if the Element is currently active within the model, false if the element has been deleted or is in the process of being deleted. (Inherited from ModelElement) |
| IsDeleted |
Has the element been deleted from the model. (Deleted elements are not immediately destroyed so that the undo command may undo deleting the element.) (Inherited from ModelElement) |
| IsDeleting |
Has the element been deleted from the model. (Deleted elements are not immediately destroyed so that the undo command may undo deleting the element.) (Inherited from ModelElement) |
| 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 instance that contains this element. (Inherited from ModelElement) |
| RootClass |
Gets or sets RootClass. Root class defining the element represented by the top node of the explorer and at the root of the xml document persisting a model. (Inherited from Editor) |
| Store |
Get the Store instance that contains this element. (Inherited from ModelElement) |
| ToolboxTabs |
Gets a list of ToolboxTabs. Toolbox tabs defined by the editor. (Inherited from Editor) |
| UsesStickyToolboxItems |
Gets or sets the value of UsesStickyToolboxItems domain property. If true, sticky toolbox items behavior is enabled. |
| Validation |
Gets or sets Validation. Validation behavior defined by the editor. (Inherited from Editor) |
| XmlSerializationDefinition |
Gets or sets XmlSerializationDefinition. Xml serialization behavior wrapper defined by the editor. (Inherited from Editor) |
Methods
| CanMerge(ProtoElementBase, ElementGroupPrototype) |
Returns a value indicating whether the source element represented by the specified root ProtoElement can be added to this element. (Inherited from Editor) |
| ChooseMergeTarget(ElementGroup) |
Gets the ModelElement to be used as the target for the ElementGroup merge
process. |
| ChooseMergeTarget(ElementGroupPrototype) |
Gets the ModelElement to be used as the target for the ElementGroupPrototype merge
process. |
| Copy() |
Creates a copy of the element in the model. (Inherited from ModelElement) |
| Copy(IEnumerable<Guid>) |
Creates a copy of the element in the model. (Inherited from ModelElement) |
| Delete() |
Deletes the element from the model. (Inherited from ModelElement) |
| Delete(Guid[]) |
Deletes the element from the model. (Inherited from ModelElement) |
| GetDomainClass() |
Gets the most-derived domain class for this element. (Inherited from ModelElement) |
| GetRoleCollection<TCollection,TElement>(Guid) |
Gets or creates the linked element collection (Inherited from ModelElement) |
| MergeConfigure(ElementGroup) |
Configure an editor after it has been merged in to a Dsl. (Inherited from Editor) |
| MergeDisconnect(ModelElement) |
Performs operation opposite to MergeRelate - i.e. disconnects a given element from the current one (removes links created by MergeRelate). (Inherited from Editor) |
| MergeRelate(ModelElement, ElementGroup) |
Called by the Merge process to create a relationship between this target element and the specified source element. Typically, a parent-child relationship is established between the target element (the parent) and the source element (the child), but any relationship can be established. (Inherited from Editor) |
| OnCopy(ModelElement) |
Called when a copy of the element has been created. The method is called on the duplicate element. (Inherited from ModelElement) |
| OnDeleted() |
Called by the model after the element has been deleted. (Inherited from ModelElement) |
| OnDeleting() |
Called by the model before the element is deleted. (Inherited from ModelElement) |
| OnResurrected() |
Called by the model after the element has been resurrected (placed back into the store). (Inherited from ModelElement) |
| OnRolePlayerPositionChanged(DomainRoleInfo, ElementLink, Int32, Int32) |
Virtual method for notifying when role player position has changed. (Inherited from ModelElement) |
| OnRolePlayerPositionChanging(DomainRoleInfo, ElementLink, Int32, Int32) |
Virtual method for notifying when role player position will be changing. (Inherited from ModelElement) |
Explicit Interface Implementations
| IMergeElements.CanMerge(ProtoElementBase, ElementGroupPrototype) | (Inherited from ModelElement) |
| IMergeElements.ChooseMergeTarget(ElementGroup) | (Inherited from ModelElement) |
| IMergeElements.ChooseMergeTarget(ElementGroupPrototype) | (Inherited from ModelElement) |
| IMergeElements.MergeConfigure(ElementGroup) | (Inherited from ModelElement) |
| IMergeElements.MergeDisconnect(ModelElement) | (Inherited from ModelElement) |
| IMergeElements.MergeRelate(ModelElement, ElementGroup) | (Inherited from ModelElement) |
Extension Methods
| AddExtension(ModelElement, DomainClassInfo) |
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. |
| AddExtension(ModelElement, ExtensionElement) |
Extend this ModelElement with a specific extension. An InvalidOperationException will be thrown if the element already has an extension of the same type. |
| AddExtension(ModelElement, Guid) |
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. |
| AddExtension(ModelElement, Type) |
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. |
| AddExtension<T>(ModelElement) |
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. |
| GetAllExtensions(ModelElement) |
Return an enumerable that performs a breadth first traversal across the tree of extension elements embedded in this ModelElement. |
| GetBaseElement(ModelElement) |
Returns the root of the virtual MEL in which the specified ModelElement is participating. |
| GetExtension(ModelElement, DomainClassInfo) | |
| GetExtension(ModelElement, Guid) | |
| GetExtension(ModelElement, Type) |
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. |
| GetExtension<T>(ModelElement) |
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. |
| IsExtendedBy(ModelElement, DomainClassInfo) |
Query whether this ModelElement is currently extended by an ExtensionElement of a particular type. |
| IsExtendedBy(ModelElement, Guid) |
Query whether this ModelElement is currently extended by an ExtensionElement of a particular type. |
| IsExtendedBy(ModelElement, Type) |
Query whether this ModelElement is currently extended by an ExtensionElement of a particular type. |
| RemoveExtension(ModelElement, DomainClassInfo) |
Remove any extension of the specified ModelElement that is of a particular type. |
| RemoveExtension(ModelElement, ExtensionElement) |
Remove a specified ExtensionElement from the extensions of this ModelElement. |
| RemoveExtension(ModelElement, Guid) |
Remove any extension of the specified ModelElement that is of a particular type. |
| RemoveExtension(ModelElement, Type) |
Remove any extension of this ModelElement that is of a particular type. |
| TryGetExtension(ModelElement, DomainClassInfo) | |
| TryGetExtension(ModelElement, Guid) | |
| TryGetExtension(ModelElement, Type) | |
| TryGetExtension<T>(ModelElement) |
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. |
| CanDelete(ModelElement, Guid[]) |
Deletes the element from the model. |
| GetLocks(ModelElement) |
Get the lock flags for this element. This will include any locks enabled on the Partition containing the element. |
| IsLocked(ModelElement, Locks) |
Test whether this element has any of a specified set of locks |
| SetLocks(ModelElement, Locks) |
Set the lock flags of this element |