Compartment Class

Reference

Definition

Namespace:: Microsoft.VisualStudio.Modeling.DslDefinition

Assembly:: Microsoft.VisualStudio.Modeling.Sdk.DslDefinition.15.0.dll

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 Compartment Defines a compartment of a compartment shape.

public ref class Compartment sealed : Microsoft::VisualStudio::Modeling::DslDefinition::DomainElement

[Microsoft.VisualStudio.Modeling.Design.DescriptionResource("Microsoft.VisualStudio.Modeling.DslDefinition.Compartment.Description", typeof(Microsoft.VisualStudio.Modeling.DslDefinition.DslDefinitionModelDomainModel), "Microsoft.VisualStudio.Modeling.DslDefinition.GeneratedCode.DomainModelResx")]
[Microsoft.VisualStudio.Modeling.Design.DisplayNameResource("Microsoft.VisualStudio.Modeling.DslDefinition.Compartment.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("4d2a3f07-db96-4774-93d3-6b82dc9bc3cc")]
[System.CLSCompliant(true)]
[System.Diagnostics.DebuggerDisplay("{GetType().Name,nq} (Name = {namePropertyStorage})")]
public sealed class Compartment : Microsoft.VisualStudio.Modeling.DslDefinition.DomainElement

[<Microsoft.VisualStudio.Modeling.Design.DescriptionResource("Microsoft.VisualStudio.Modeling.DslDefinition.Compartment.Description", typeof(Microsoft.VisualStudio.Modeling.DslDefinition.DslDefinitionModelDomainModel), "Microsoft.VisualStudio.Modeling.DslDefinition.GeneratedCode.DomainModelResx")>]
[<Microsoft.VisualStudio.Modeling.Design.DisplayNameResource("Microsoft.VisualStudio.Modeling.DslDefinition.Compartment.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("4d2a3f07-db96-4774-93d3-6b82dc9bc3cc")>]
[<System.CLSCompliant(true)>]
[<System.Diagnostics.DebuggerDisplay("{GetType().Name,nq} (Name = {namePropertyStorage})")>]
type Compartment = class
    inherit DomainElement

Public NotInheritable Class Compartment
Inherits DomainElement

Inheritance: Object

ModelElement

DomainElement
Compartment

Attributes: DescriptionResourceAttribute DisplayNameResourceAttribute DomainModelOwnerAttribute DomainObjectIdAttribute CLSCompliantAttribute DebuggerDisplayAttribute

Constructors

Compartment(Partition, PropertyAssignment[])	Constructor
Compartment(Store, PropertyAssignment[])	Constructor

Fields

DefaultExpandCollapseStateDomainPropertyId	DefaultExpandCollapseState domain property Id.
DomainClassId	Compartment domain class Id.
EntryFontSizeDomainPropertyId	EntryFontSize domain property Id.
EntryFontStyleDomainPropertyId	EntryFontStyle domain property Id.
EntryTextColorDomainPropertyId	EntryTextColor domain property Id.
FillColorDomainPropertyId	FillColor domain property Id.
NameDomainPropertyId	Name domain property Id.
TitleDomainPropertyId	Title domain property Id.
TitleFillColorDomainPropertyId	TitleFillColor domain property Id.
TitleFontSizeDomainPropertyId	TitleFontSize domain property Id.
TitleFontStyleDomainPropertyId	TitleFontStyle domain property Id.
TitleTextColorDomainPropertyId	TitleTextColor domain property Id.

Properties

CompartmentMaps	Gets a list of CompartmentMaps.
DefaultExpandCollapseState	Gets or sets the value of DefaultExpandCollapseState domain property. If Expanded, then the compartment is expanded on creation.
EntryFontSize	Gets or sets the value of EntryFontSize domain property. Font size of an entry in the compartment list.
EntryFontStyle	Gets or sets the value of EntryFontStyle domain property. Font style of an entry in the compartment list.
EntryTextColor	Gets or sets the value of EntryTextColor domain property. Text color of an entry in the compartment list.
FillColor	Gets or sets the value of FillColor domain property. Fill color of the compartment.
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)
Name	Gets or sets the value of Name domain property. Name of the compartment.
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)
Shape	Gets or sets Shape. Compartment shape defining the compartments.
Store	Get the Store instance that contains this element. (Inherited from ModelElement)
Title	Gets or sets the value of Title domain property. Text that is displayed as the title of the compartment.
TitleFillColor	Gets or sets the value of TitleFillColor domain property. Fill color for the title area of the compartment.
TitleFontSize	Gets or sets the value of TitleFontSize domain property. Font size for text in the title of the compartment.
TitleFontStyle	Gets or sets the value of TitleFontStyle domain property. Font style for text in the title of the compartment.
TitleTextColor	Gets or sets the value of TitleTextColor domain property. Color of text in the title of the compartment.

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 ModelElement)
ChooseMergeTarget(ElementGroup)	Gets the ModelElement to be used as the target for the ElementGroup merge process. This is called by the merge process when this element is the target of the merge. This provides this element with the opportunity to change the target to something other than itself. (Inherited from ModelElement)
ChooseMergeTarget(ElementGroupPrototype)	Gets the ModelElement to be used as the target for the ElementGroupPrototype merge process. This is called by the merge process when this element is the target of the merge. This provides this element with the opportunity to change the target to something other than itself. (Inherited from ModelElement)
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)	Called by the Merge process to allow this model element to configure itself immediately after the Merge process has related it to the target element. (Inherited from ModelElement)
MergeDisconnect(ModelElement)	Performs operation opposite to MergeRelate - i.e. disconnects a given element from the current one (removes links created by MergeRelate). (Inherited from ModelElement)
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 ModelElement)
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

Applies to