PropertySet Class

Definition

Namespace:

DocumentFormat.OpenXml.Drawing.Diagrams

Assembly:

DocumentFormat.OpenXml.dll

Package:

DocumentFormat.OpenXml v3.0.1

Property Set.

This class is available in Office 2007 and above.

When the object is serialized out as xml, it's qualified name is dgm:prSet.

public class PropertySet : DocumentFormat.OpenXml.OpenXmlCompositeElement

type PropertySet = class
    inherit OpenXmlCompositeElement

Public Class PropertySet
Inherits OpenXmlCompositeElement

Inheritance

Object

OpenXmlElement

OpenXmlCompositeElement

PropertySet

Remarks

[ISO/IEC 29500-1 1st Edition]

prSet (Property Set)

This element holds properties and customizations which are used throughout certain elements in DiagramML. The properties can be grouped into the following general categories:

• Presentation Properties - presLayoutVars, style, presAssocId, presName, presStyleLbl, presStyleIdx, presStyleCnt

• Document Properties - loTypeId, loCatId, qsTypeId, qaCatId, csTypeId, coherent3DOff

• Semantic Element Properties - phldrT, phldr

• Customization Properties - custAng, custFlipVert, custFlipHor, custSzX, custSzY, custScaleX, custScaleY, custT, custLinFactX, custLinFactY, custLinFactNeighborX, custLinFactNeighborY, custRadScaleRad, custRadScaleInc

[Example: Consider the basic example of prSet in use in DrawingML on a document point type:

<prSet loTypeId="urn:microsoft.com/office/officeart/2005/8/layout/default" loCatId="list" qsTypeId="urn:microsoft.com/office/officeart/2005/8/quickstyle/3d1" qsCatId="3D" csTypeId="urn:microsoft.com/office/officeart/2005/8/colors/colorful2" csCatId="colorful" phldr="1"/>  

In this example we define the layout identifier, the category of the layout, the quick style identifier, the quick style category, along with the color style and color style category. end example]

Parent Elements
pt (§21.4.3.5)

Child Elements	Subclause
presLayoutVars (Presentation Layout Variables)	§21.4.5.4
style (Shape Style)	§21.4.2.28

Attributes	Description
coherent3DOff (Coherent 3D Behavior)	Enables or disables the Coherent 3D behavior for styles that specify this property. The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
csCatId (Color Transform Category)	This attribute specifies the identifier of the current color transform category. The possible values for this attribute are defined by the W3C XML Schema string datatype.
csTypeId (Color Transform Type Identifier)	This attribute specifies the identifier of the currently applied color transform. The possible values for this attribute are defined by the W3C XML Schema string datatype.
custAng (Custom Rotation)	Specifies the amount that rotation is customized by. The possible values for this attribute are defined by the W3C XML Schema int datatype.
custFlipHor (Custom Horizontal Flip)	Specifies if there is a custom horizontal flip applied. The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
custFlipVert (Custom Vertical Flip)	Specifies if there is a custom vertical flip applied. The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
custLinFactNeighborX (Neighbor Offset Width)	Specifies the percentage of the neighbor's width used for offsetting shape. The possible values for this attribute are defined by the W3C XML Schema int datatype.
custLinFactNeighborY (Neighbor Offset Height)	Specifies the percentage of the neighbor's height used for offsetting shape. The possible values for this attribute are defined by the W3C XML Schema int datatype.
custLinFactX (Custom Factor Width)	Specifies the percentage of the current shape width used for offsetting the shape. The possible values for this attribute are defined by the W3C XML Schema int datatype.
custLinFactY (Custom Factor Height)	Specifies the percentage of the current shape height used for offsetting the shape. The possible values for this attribute are defined by the W3C XML Schema int datatype.
custRadScaleInc (Include Angle Scale)	Specifies the amount that the include angle has been scaled by. The possible values for this attribute are defined by the W3C XML Schema int datatype.
custRadScaleRad (Radius Scale)	Specifies how much the radius has been scaled. The possible values for this attribute are defined by the W3C XML Schema int datatype.
custScaleX (Width Scale)	Specifies the amount that the width has been scaled by. The possible values for this attribute are defined by the W3C XML Schema int datatype.
custScaleY (Height Scale)	Specifies the amount that the height has been scaled by. The possible values for this attribute are defined by the W3C XML Schema int datatype.
custSzX (Fixed Width Override)	Specifies a fixed width override for a shape. The possible values for this attribute are defined by the W3C XML Schema int datatype.
custSzY (Fixed Height Override)	Specifies a fixed height override for a shape. The possible values for this attribute are defined by the W3C XML Schema int datatype.
custT (Text Changed)	Specifies if the text has been customized which allows layout to ignore automatic formatting options available to the text. The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
loCatId (Current Diagram Category)	Specifies the current identifier of the layout category applied to the diagram. The possible values for this attribute are defined by the W3C XML Schema string datatype.
loTypeId (Current Diagram Type)	Specifies the identifier for the layout currently applied to the diagram. The possible values for this attribute are defined by the W3C XML Schema string datatype.
phldr (Placeholder)	Indicates that the point is a placeholder or sample item. The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
phldrT (Placeholder Text)	The text used for display in the element if the placeholder flag is set to true. If this property is not set then the default placeholder text is used. The possible values for this attribute are defined by the W3C XML Schema string datatype.
presAssocID (Presentation Element Identifier)	The point associated with this presentation element. This identifier is used together with presName to create a unique key for presentation element indexing. The possible values for this attribute are defined by the ST_ModelId simple type (§21.4.7.43).
presName (Presentation Name)	The layout node name of this presentation element. This name is used together with presAssocID to create a unique key for presentation element indexing. The possible values for this attribute are defined by the W3C XML Schema string datatype.
presStyleCnt (Presentation Style Count)	Specifies the layout node style count of this presentation element. The possible values for this attribute are defined by the W3C XML Schema int datatype.
presStyleIdx (Presentation Style Index)	Specifies the layout node style index of this presentation element. The possible values for this attribute are defined by the W3C XML Schema int datatype.
presStyleLbl (Presentation Style Label)	Specifies the layout node style label of this presentation element. The possible values for this attribute are defined by the W3C XML Schema string datatype.
qsCatId (Current Style Category)	Specifies the identifier of the category of the currently applied quick style. The possible values for this attribute are defined by the W3C XML Schema string datatype.
qsTypeId (Current Style Type)	Specifies the identifier of the currently applied quick style. The possible values for this attribute are defined by the W3C XML Schema string datatype.

[Note: The W3C XML Schema definition of this element’s content model (CT_ElemPropSet) is located in §A.5.3. end note]

� ISO/IEC29500: 2008.

Constructors

PropertySet()	Initializes a new instance of the PropertySet class.
PropertySet(IEnumerable<OpenXmlElement>)	Initializes a new instance of the PropertySet class with the specified child elements.
PropertySet(OpenXmlElement[])	Initializes a new instance of the PropertySet class with the specified child elements.
PropertySet(String)	Initializes a new instance of the PropertySet class from outer XML.

Properties

ChildElements	Gets all the child nodes of the current element. (Inherited from OpenXmlElement)
Coherent3D	Coherent 3D Behavior Represents the following attribute in the schema: coherent3DOff
ColorCategoryId	Color Transform Category Represents the following attribute in the schema: csCatId
ColorType	Color Transform Type Identifier Represents the following attribute in the schema: csTypeId
ExtendedAttributes	Gets all extended attributes (attributes not defined in the schema) of the current element. (Inherited from OpenXmlElement)
FactorHeight	Custom Factor Height Represents the following attribute in the schema: custLinFactY
FactorWidth	Custom Factor Width Represents the following attribute in the schema: custLinFactX
Features	Gets a IFeatureCollection for the current element. This feature collection will be read-only, but will inherit features from its parent part and package if available. (Inherited from OpenXmlElement)
FirstChild	Gets the first child of the current OpenXmlElement element. (Inherited from OpenXmlCompositeElement)
FixedHeightOverride	Fixed Height Override Represents the following attribute in the schema: custSzY
FixedWidthOverride	Fixed Width Override Represents the following attribute in the schema: custSzX
HasAttributes	Gets a value indicating whether the current element has any attributes. (Inherited from OpenXmlElement)
HasChildren	Gets a value that indicates whether the current element has any child elements. (Inherited from OpenXmlCompositeElement)
HeightScale	Height Scale Represents the following attribute in the schema: custScaleY
HorizontalFlip	Custom Horizontal Flip Represents the following attribute in the schema: custFlipHor
IncludeAngleScale	Include Angle Scale Represents the following attribute in the schema: custRadScaleInc
InnerText	Gets or sets the concatenated values of the current node and all of its children. (Inherited from OpenXmlCompositeElement)
InnerXml	Gets or sets the markup that represents only the child nodes of the current node. (Inherited from OpenXmlCompositeElement)
LastChild	Gets the last child of the current OpenXmlElement element. Returns null (Nothing in Visual Basic) if there is no such OpenXmlElement element. (Inherited from OpenXmlCompositeElement)
LayoutCategoryId	Current Diagram Category Represents the following attribute in the schema: loCatId
LayoutTypeId	Current Diagram Type Represents the following attribute in the schema: loTypeId
LocalName	Gets the local name of the current element. (Inherited from OpenXmlElement)
MCAttributes	Gets or sets the markup compatibility attributes. Returns null if no markup compatibility attributes are defined for the current element. (Inherited from OpenXmlElement)
NamespaceDeclarations	Gets all the namespace declarations defined in the current element. Returns an empty enumerator if there is no namespace declaration. (Inherited from OpenXmlElement)
NamespaceUri	Gets the namespace URI of the current element. (Inherited from OpenXmlElement)
NeighborOffsetHeight	Neighbor Offset Height Represents the following attribute in the schema: custLinFactNeighborY
NeighborOffsetWidth	Neighbor Offset Width Represents the following attribute in the schema: custLinFactNeighborX
OpenXmlElementContext	Gets the OpenXmlElementContext of the current element. (Inherited from OpenXmlElement)
OuterXml	Gets the markup that represents the current element and all of its child elements. (Inherited from OpenXmlElement)
Parent	Gets the parent element of the current element. (Inherited from OpenXmlElement)
Placeholder	Placeholder Represents the following attribute in the schema: phldr
PlaceholderText	Placeholder Text Represents the following attribute in the schema: phldrT
Prefix	Gets the namespace prefix of current element. (Inherited from OpenXmlElement)
PresentationElementId	Presentation Element Identifier Represents the following attribute in the schema: presAssocID
PresentationLayoutVariables	Presentation Layout Variables. Represents the following element tag in the schema: dgm:presLayoutVars.
PresentationName	Presentation Name Represents the following attribute in the schema: presName
PresentationStyleCount	Presentation Style Count Represents the following attribute in the schema: presStyleCnt
PresentationStyleIndex	Presentation Style Index Represents the following attribute in the schema: presStyleIdx
PresentationStyleLabel	Presentation Style Label Represents the following attribute in the schema: presStyleLbl
QuickStyleCategoryId	Current Style Category Represents the following attribute in the schema: qsCatId
QuickStyleTypeId	Current Style Type Represents the following attribute in the schema: qsTypeId
RadiusScale	Radius Scale Represents the following attribute in the schema: custRadScaleRad
Rotation	Custom Rotation Represents the following attribute in the schema: custAng
Style	Shape Style. Represents the following element tag in the schema: dgm:style.
TextChanged	Text Changed Represents the following attribute in the schema: custT
VerticalFlip	Custom Vertical Flip Represents the following attribute in the schema: custFlipVert
WidthScale	Width Scale Represents the following attribute in the schema: custScaleX
XmlQualifiedName	Gets the qualified name of the current element. (Inherited from OpenXmlElement)
XName	Gets the qualified name of the current element. (Inherited from OpenXmlElement)

Methods

AddAnnotation(Object)	Adds an object to the current OpenXmlElement element's list of annotations. (Inherited from OpenXmlElement)
AddChild(OpenXmlElement, Boolean)	Adds the specified element to the element if it is a known child. This adds the element in the correct location according to the schema. (Inherited from OpenXmlCompositeElement)
AddNamespaceDeclaration(String, String)	Adds a namespace declaration to the current node. (Inherited from OpenXmlElement)
Ancestors()	Enumerates all of the current element's ancestors. (Inherited from OpenXmlElement)
Ancestors<T>()	Enumerates only the current element's ancestors that have the specified type. (Inherited from OpenXmlElement)
Annotation(Type)	Get the first annotation object of the specified type from the current OpenXmlElement element. (Inherited from OpenXmlElement)
Annotation<T>()	Get the first annotation object of the specified type from the current OpenXmlElement element. (Inherited from OpenXmlElement)
Annotations(Type)	Gets a collection of annotations with the specified type for the current OpenXmlElement element. (Inherited from OpenXmlElement)
Annotations<T>()	Gets a collection of annotations with the specified type for the current OpenXmlElement element. (Inherited from OpenXmlElement)
Append(IEnumerable<OpenXmlElement>)	Appends each element from a list of elements to the end of the current element's list of child elements. (Inherited from OpenXmlElement)
Append(OpenXmlElement[])	Appends each element from an array of elements to the end of the current element's list of child elements. (Inherited from OpenXmlElement)
AppendChild<T>(T)	Appends the specified element to the end of the current element's list of child nodes. (Inherited from OpenXmlCompositeElement)
ClearAllAttributes()	Clears all of the attributes, including both known attributes and extended attributes. (Inherited from OpenXmlElement)
Clone()	Creates a duplicate of the current node. (Inherited from OpenXmlElement)
CloneNode(Boolean)	Creates a duplicate of this node.
Descendants()	Enumerates all of the current element's descendants. (Inherited from OpenXmlElement)
Descendants<T>()	Enumerate all of the current element's descendants of type T. (Inherited from OpenXmlElement)
Elements()	Enumerates all of the current element's children. (Inherited from OpenXmlElement)
Elements<T>()	Enumerates only the current element's children that have the specified type. (Inherited from OpenXmlElement)
ElementsAfter()	Enumerates all of the sibling elements that follow the current element and have the same parent as the current element. (Inherited from OpenXmlElement)
ElementsBefore()	Enumerates all of the sibling elements that precede the current element and have the same parent as the current element. (Inherited from OpenXmlElement)
GetAttribute(String, String)	Gets an Open XML attribute with the specified tag name and namespace URI. (Inherited from OpenXmlElement)
GetAttributes()	Gets a list that contains a copy of all the attributes. (Inherited from OpenXmlElement)
GetEnumerator()	Returns an enumerator that iterates through the child collection. (Inherited from OpenXmlElement)
GetFirstChild<T>()	Finds the first child element in type T. (Inherited from OpenXmlElement)
InsertAfter<T>(T, OpenXmlElement)	Inserts the specified element immediately after the specified reference element. (Inherited from OpenXmlCompositeElement)
InsertAfterSelf<T>(T)	Inserts the specified element immediately after the current element. (Inherited from OpenXmlElement)
InsertAt<T>(T, Int32)	Inserts the specified element at the specified index of the current element's children. (Inherited from OpenXmlCompositeElement)
InsertBefore<T>(T, OpenXmlElement)	Inserts the specified element immediately before the specified reference element. (Inherited from OpenXmlCompositeElement)
InsertBeforeSelf<T>(T)	Inserts the specified element immediately before the current element. (Inherited from OpenXmlElement)
IsAfter(OpenXmlElement)	Determines if the current element appears after a specified element in document order. (Inherited from OpenXmlElement)
IsBefore(OpenXmlElement)	Determines if the current element appears before a specified element in document order. (Inherited from OpenXmlElement)
LookupNamespace(String)	Resolves the namespace prefix in the context of the current node. (Inherited from OpenXmlElement)
LookupPrefix(String)	Finds the corresponding prefix for a namespace uri in the current element scope. (Inherited from OpenXmlElement)
NextSibling()	Gets the OpenXmlElement element that immediately follows the current OpenXmlElement element. Returns null (Nothing in Visual Basic) if there is no next OpenXmlElement element. (Inherited from OpenXmlElement)
NextSibling<T>()	Gets the OpenXmlElement element with the specified type that follows the current OpenXmlElement element. Returns null (Nothing in Visual Basic) if there is no next OpenXmlElement. (Inherited from OpenXmlElement)
PrependChild<T>(T)	Inserts the specified element at the beginning of the current element's list of child nodes. (Inherited from OpenXmlCompositeElement)
PreviousSibling()	Gets the OpenXmlElement element that immediately precedes the current OpenXmlElement element. Returns null (Nothing in Visual Basic ) if there is no preceding OpenXmlElement element. (Inherited from OpenXmlElement)
PreviousSibling<T>()	Gets the OpenXmlElement element with the specified type that precedes the current OpenXmlElement. Returns null (Nothing in Visual Basic) if there is no preceding OpenXmlElement element. (Inherited from OpenXmlElement)
Remove()	Removes the current element from its parent. (Inherited from OpenXmlElement)
RemoveAllChildren()	Removes all of the current element's child elements. (Inherited from OpenXmlCompositeElement)
RemoveAllChildren<T>()	Remove all of the current element's child elements that are of type T. (Inherited from OpenXmlElement)
RemoveAnnotations(Type)	Removes the annotations of the specified type from the current OpenXmlElement element. (Inherited from OpenXmlElement)
RemoveAnnotations<T>()	Removes the annotations with the specified type from the current OpenXmlElement element. (Inherited from OpenXmlElement)
RemoveAttribute(String, String)	Removes the attribute from the current element. (Inherited from OpenXmlElement)
RemoveChild<T>(T)	Removes the specified child element. (Inherited from OpenXmlCompositeElement)
RemoveNamespaceDeclaration(String)	Removes the namespace declaration for the specified prefix. Removes nothing if there is no prefix. (Inherited from OpenXmlElement)
ReplaceChild<T>(OpenXmlElement, T)	Replaces one of the current element's child elements with another OpenXmlElement element. (Inherited from OpenXmlCompositeElement)
SetAttribute(OpenXmlAttribute)	Sets an attribute to the specified element. If the attribute is a known attribute, the value of the attribute is set. If the attribute is an extended attribute, the 'openxmlAttribute' is added to the extended attributes list. (Inherited from OpenXmlElement)
SetAttributes(IEnumerable<OpenXmlAttribute>)	Sets a number of attributes to the element. If an attribute is a known attribute, the value of the attribute is set. If an attribute is an extended attribute, the 'openxmlAttribute' is added to the extended attributes list. (Inherited from OpenXmlElement)
WriteTo(XmlWriter)	Saves the current node to the specified XmlWriter. (Inherited from OpenXmlElement)

Explicit Interface Implementations

IEnumerable.GetEnumerator()	(Inherited from OpenXmlElement)
IEnumerable<OpenXmlElement>.GetEnumerator()	Returns an enumerator that iterates through the child collection. (Inherited from OpenXmlElement)