Parameter Class

Parameter.When the object is serialized out as xml, its qualified name is dgm:param.

Inheritance Hierarchy

System.Object
  DocumentFormat.OpenXml.OpenXmlElement
    DocumentFormat.OpenXml.OpenXmlLeafElement
      DocumentFormat.OpenXml.Drawing.Diagrams.Parameter

Namespace:  DocumentFormat.OpenXml.Drawing.Diagrams
Assembly:  DocumentFormat.OpenXml (in DocumentFormat.OpenXml.dll)

Syntax

'Declaration
Public Class Parameter _
    Inherits OpenXmlLeafElement
'Usage
Dim instance As Parameter
public class Parameter : OpenXmlLeafElement

Remarks

[ISO/IEC 29500-1 1st Edition]

21.4.2.20 param (Parameter)

The parameter element modifies the default behavior of an algorithm.

[Example: Consider the following example of a param being used in a DrawingML diagram:

<alg type="snake">
<param type="grDir" val="tL"/>
<param type="flowDir" val="row"/>
<param type="contDir" val="sameDir"/>
<param type="off" val="ctr"/>
</alg>

In this example we see the snake algorithm being utilized and four parameters being set which are associated with the snake algorithm and modify its behavior. end example]

Parent Elements

alg (§21.4.2.3)

Attributes

Description

type (Parameter Type)

Specifies the parameter which is being modified.

The possible values for this attribute are defined by the ST_ParameterId simple type (§21.4.7.49).

val (Value)

Specifies the actual value to be given to the parameter type defined by the type attribute.

The possible values for this attribute are defined by the ST_ParameterVal simple type (§21.4.7.50).

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

© ISO/IEC29500: 2008.

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

Parameter Members

DocumentFormat.OpenXml.Drawing.Diagrams Namespace