Share via


XmlClassData Class

DomainClass XmlClassData Defines how elements of a specific domain class are serialized in xml.

Inheritance Hierarchy

System.Object
  Microsoft.VisualStudio.Modeling.ModelElement
    Microsoft.VisualStudio.Modeling.DslDefinition.DomainElement
      Microsoft.VisualStudio.Modeling.DslDefinition.XmlClassData

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

Syntax

'Declaration
<ValidationStateAttribute(ValidationState.Enabled)> _
<DisplayNameResourceAttribute("Microsoft.VisualStudio.Modeling.DslDefinition.XmlClassData.DisplayName",  _
    GetType(DslDefinitionModelDomainModel), "Microsoft.VisualStudio.Modeling.DslDefinition.GeneratedCode.DomainModelResx")> _
<DescriptionResourceAttribute("Microsoft.VisualStudio.Modeling.DslDefinition.XmlClassData.Description",  _
    GetType(DslDefinitionModelDomainModel), "Microsoft.VisualStudio.Modeling.DslDefinition.GeneratedCode.DomainModelResx")> _
<DomainModelOwnerAttribute(GetType(DslDefinitionModelDomainModel))> _
<CLSCompliantAttribute(True)> _
<DomainObjectIdAttribute("7ef099b3-251f-4518-84ad-0640f5ca7bfc")> _
Public NotInheritable Class XmlClassData _
    Inherits DomainElement
[ValidationStateAttribute(ValidationState.Enabled)]
[DisplayNameResourceAttribute("Microsoft.VisualStudio.Modeling.DslDefinition.XmlClassData.DisplayName", 
    typeof(DslDefinitionModelDomainModel), "Microsoft.VisualStudio.Modeling.DslDefinition.GeneratedCode.DomainModelResx")]
[DescriptionResourceAttribute("Microsoft.VisualStudio.Modeling.DslDefinition.XmlClassData.Description", 
    typeof(DslDefinitionModelDomainModel), "Microsoft.VisualStudio.Modeling.DslDefinition.GeneratedCode.DomainModelResx")]
[DomainModelOwnerAttribute(typeof(DslDefinitionModelDomainModel))]
[CLSCompliantAttribute(true)]
[DomainObjectIdAttribute("7ef099b3-251f-4518-84ad-0640f5ca7bfc")]
public sealed class XmlClassData : DomainElement
[ValidationStateAttribute(ValidationState::Enabled)]
[DisplayNameResourceAttribute(L"Microsoft.VisualStudio.Modeling.DslDefinition.XmlClassData.DisplayName", 
    typeof(DslDefinitionModelDomainModel), L"Microsoft.VisualStudio.Modeling.DslDefinition.GeneratedCode.DomainModelResx")]
[DescriptionResourceAttribute(L"Microsoft.VisualStudio.Modeling.DslDefinition.XmlClassData.Description", 
    typeof(DslDefinitionModelDomainModel), L"Microsoft.VisualStudio.Modeling.DslDefinition.GeneratedCode.DomainModelResx")]
[DomainModelOwnerAttribute(typeof(DslDefinitionModelDomainModel))]
[CLSCompliantAttribute(true)]
[DomainObjectIdAttribute(L"7ef099b3-251f-4518-84ad-0640f5ca7bfc")]
public ref class XmlClassData sealed : public DomainElement
[<Sealed>]
[<ValidationStateAttribute(ValidationState.Enabled)>]
[<DisplayNameResourceAttribute("Microsoft.VisualStudio.Modeling.DslDefinition.XmlClassData.DisplayName", 
    typeof(DslDefinitionModelDomainModel), "Microsoft.VisualStudio.Modeling.DslDefinition.GeneratedCode.DomainModelResx")>]
[<DescriptionResourceAttribute("Microsoft.VisualStudio.Modeling.DslDefinition.XmlClassData.Description", 
    typeof(DslDefinitionModelDomainModel), "Microsoft.VisualStudio.Modeling.DslDefinition.GeneratedCode.DomainModelResx")>]
[<DomainModelOwnerAttribute(typeof(DslDefinitionModelDomainModel))>]
[<CLSCompliantAttribute(true)>]
[<DomainObjectIdAttribute("7ef099b3-251f-4518-84ad-0640f5ca7bfc")>]
type XmlClassData =  
    class 
        inherit DomainElement 
    end
public final class XmlClassData extends DomainElement

The XmlClassData type exposes the following members.

Constructors

  Name Description
Public method XmlClassData(Partition, array<PropertyAssignment[]) Constructor
Public method XmlClassData(Store, array<PropertyAssignment[]) Constructor

Top

Properties

  Name Description
Public property Behavior Gets or sets Behavior. Defining xml serialization behavior.
Public property DomainClass Gets or sets DomainClass. Class to which the xml serialization configuration data applies.
Public property ElementData Gets a list of ElementData. Xml serialization configuration data for elements of the class.
Public property ElementName Gets or sets the value of ElementName domain property. Xml element name used to serialize elements of the designated domain class.
Public property HasCustomElementSchema Gets or sets the value of HasCustomElementSchema domain property. Flag to indicate whether the domain class has a custom element schema
Public property HasCustomMonikerSchema Gets or sets the value of HasCustomMonikerSchema domain property. Flag to indicate whether the domain class has a custom moniker schema
Public property Id Gets the ID of the element. (Inherited from ModelElement.)
Public property IsActive Gets the IsActive flag and verifies to see whether the element is active. (Inherited from ModelElement.)
Public property IsCustom Gets or sets the value of IsCustom domain property. If True, serialization of elements of the designated domain class is defined in custom code.
Public property IsDeleted Gets the IsDeleted flag and checks to see whether the element has been deleted from the model. (Inherited from ModelElement.)
Public property IsDeleting Gets the IsDeleting flag and verifies whether the element is currently being deleted from the model. (Inherited from ModelElement.)
Public property IsElementNameTracking Gets or sets the value of IsElementNameTracking domain property. If True, the ElementName property tracks other data in the DSL definition.
Public property IsMonikerAttributeNameTracking Gets or sets the value of IsMonikerAttributeNameTracking domain property. If True, the MonikerAttributeName property tracks other data in the DSL definition.
Public property IsMonikerElementNameTracking Gets or sets the value of IsMonikerElementNameTracking domain property. If True, the MonikerElementName property tracks other data in the DSL definition.
Public property IsMonikerTypeNameTracking Gets or sets the value of IsMonikerTypeNameTracking domain property. If True, the MonikerTypeName property tracks other data in the DSL definition.
Public property IsSerializeIdTracking Gets or sets the value of IsSerializeIdTracking domain property. If True, the SerializeId property tracks other data in the DSL definition.
Public property IsTypeNameTracking Gets or sets the value of IsTypeNameTracking domain property. If True, the TypeName property tracks other data in the DSL definition.
Public property MonikerAttributeName Gets or sets the value of MonikerAttributeName domain property. Name of attribute used in moniker elements to contain the reference. If blank, the name of the key property or id is used.
Public property MonikerElementName Gets or sets the value of MonikerElementName domain property. Name of the xml element used for monikers to elements of the designated class.
Public property MonikerTypeName Gets or sets the value of MonikerTypeName domain property. Name of the xsd type generated for monikers to elements of this class.
Public property Notes Gets or sets the value of Notes domain property. Informal notes associated with this element. (Inherited from DomainElement.)
Public property Partition Gets or sets the Partition that contains the element. (Inherited from ModelElement.)
Public property SerializeId Gets or sets the value of SerializeId domain property. If True, serialize the element Id.
Public property Store Gets the Store that contains the element. (Inherited from ModelElement.)
Public property TypeName Gets or sets the value of TypeName domain property. Name of the xml type generated in the xsd from the designated domain class.

Top

Methods

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

Top

Extension Methods

  Name Description
Public Extension Method 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.)
Public Extension Method 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.)
Public Extension Method 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.)
Public Extension Method 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.)
Public Extension Method 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.)
Public Extension Method CanDelete Deletes the element from the model. (Defined by ImmutabilityExtensionMethods.)
Public Extension Method GetAllExtensions Return an enumerable that performs a breadth first traversal across the tree of extension elements embedded in this ModelElement. (Defined by ModelElementExtensionMethods.)
Public Extension Method GetBaseElement Returns the root of the virtual MEL in which the specified ModelElement is participating. (Defined by ModelElementExtensionMethods.)
Public Extension Method GetExtension(Guid) Overloaded. (Defined by ModelElementExtensionMethods.)
Public Extension Method 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.)
Public Extension Method GetExtension(DomainClassInfo) Overloaded. (Defined by ModelElementExtensionMethods.)
Public Extension Method 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.)
Public Extension Method GetLocks Get the lock flags for this element. This will include any locks enabled on the Partition containing the element. (Defined by ImmutabilityExtensionMethods.)
Public Extension Method IsExtendedBy(Guid) Overloaded. Query whether this ModelElement is currently extended by an ExtensionElement of a particular type. (Defined by ModelElementExtensionMethods.)
Public Extension Method IsExtendedBy(Type) Overloaded. Query whether this ModelElement is currently extended by an ExtensionElement of a particular type. (Defined by ModelElementExtensionMethods.)
Public Extension Method IsExtendedBy(DomainClassInfo) Overloaded. Query whether this ModelElement is currently extended by an ExtensionElement of a particular type. (Defined by ModelElementExtensionMethods.)
Public Extension Method IsLocked Test whether this element has any of a specified set of locks (Defined by ImmutabilityExtensionMethods.)
Public Extension Method RemoveExtension(Type) Overloaded. Remove any extension of this ModelElement that is of a particular type. (Defined by ModelElementExtensionMethods.)
Public Extension Method RemoveExtension(Guid) Overloaded. Remove any extension of the specified ModelElement that is of a particular type. (Defined by ModelElementExtensionMethods.)
Public Extension Method RemoveExtension(DomainClassInfo) Overloaded. Remove any extension of the specified ModelElement that is of a particular type. (Defined by ModelElementExtensionMethods.)
Public Extension Method RemoveExtension(ExtensionElement) Overloaded. Remove a specified ExtensionElement from the extensions of this ModelElement. (Defined by ModelElementExtensionMethods.)
Public Extension Method SetLocks Set the lock flags of this element (Defined by ImmutabilityExtensionMethods.)
Public Extension Method TryGetExtension(Guid) Overloaded. (Defined by ModelElementExtensionMethods.)
Public Extension Method TryGetExtension(Type) Overloaded. (Defined by ModelElementExtensionMethods.)
Public Extension Method TryGetExtension(DomainClassInfo) Overloaded. (Defined by ModelElementExtensionMethods.)
Public Extension Method 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
Public fieldStatic member DomainClassId XmlClassData domain class Id.
Public fieldStatic member ElementNameDomainPropertyId ElementName domain property Id.
Public fieldStatic member HasCustomElementSchemaDomainPropertyId HasCustomElementSchema domain property Id.
Public fieldStatic member HasCustomMonikerSchemaDomainPropertyId HasCustomMonikerSchema domain property Id.
Public fieldStatic member IsCustomDomainPropertyId IsCustom domain property Id.
Public fieldStatic member IsElementNameTrackingDomainPropertyId IsElementNameTracking domain property Id.
Public fieldStatic member IsMonikerAttributeNameTrackingDomainPropertyId IsMonikerAttributeNameTracking domain property Id.
Public fieldStatic member IsMonikerElementNameTrackingDomainPropertyId IsMonikerElementNameTracking domain property Id.
Public fieldStatic member IsMonikerTypeNameTrackingDomainPropertyId IsMonikerTypeNameTracking domain property Id.
Public fieldStatic member IsSerializeIdTrackingDomainPropertyId IsSerializeIdTracking domain property Id.
Public fieldStatic member IsTypeNameTrackingDomainPropertyId IsTypeNameTracking domain property Id.
Public fieldStatic member MonikerAttributeNameDomainPropertyId MonikerAttributeName domain property Id.
Public fieldStatic member MonikerElementNameDomainPropertyId MonikerElementName domain property Id.
Public fieldStatic member MonikerTypeNameDomainPropertyId MonikerTypeName domain property Id.
Public fieldStatic member SerializeIdDomainPropertyId SerializeId domain property Id.
Public fieldStatic member TypeNameDomainPropertyId TypeName domain property Id.

Top

Explicit Interface Implementations

  Name Description
Explicit interface implemetationPrivate method IMergeElements.CanMerge Returns true if this element can merge with the content of the prototype. (Inherited from ModelElement.)
Explicit interface implemetationPrivate method IMergeElements.ChooseMergeTarget(ElementGroup) (Inherited from ModelElement.)
Explicit interface implemetationPrivate method IMergeElements.ChooseMergeTarget(ElementGroupPrototype) (Inherited from ModelElement.)
Explicit interface implemetationPrivate method IMergeElements.MergeConfigure (Inherited from ModelElement.)
Explicit interface implemetationPrivate method IMergeElements.MergeDisconnect (Inherited from ModelElement.)
Explicit interface implemetationPrivate method 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.

See Also

Reference

Microsoft.VisualStudio.Modeling.DslDefinition Namespace