2.3.2 CT_Parameter

  • Article

Referenced by: CT_Parameters

A workbook parameter.

Attributes:

Name: The name of a workbook parameter. MUST be unique across the list of workbook parameters in the workbook.

Description: A user-specified description of the parameter. The maximum number of characters MUST be less than or equal to 1024.

IsPivotPageField: MUST be true if the workbook parameter is a PivotTable page field parameter and MUST NOT be present otherwise.

IsSlicer: MUST be true if the workbook parameter is a slicer and MUST NOT be present otherwise.

RequiresConnection: MUST NOT be present if IsPivotPageField is not present. If IsPivotPageField is present, this attribute MUST be true if the workbook parameter requires an external data connection to update the contents of the workbook parameter and MUST NOT be present otherwise.

The following W3C XML Schema ([XMLSCHEMA1] section 2.1) fragment specifies the contents of this complex type.

 <xs:complexType name="CT_Parameter">
   <xs:attribute name="Name" use="required" type="ST_ObjectName"/>
   <xs:attribute name="Description" use="optional" type="ST_Description"/>
   <xs:attribute name="IsPivotPageField" type="xs:boolean" default="false" use="optional"/>
   <xs:attribute name="IsSlicer" type="xs:boolean" default="false" use="optional"/>
   <xs:attribute name="RequiresConnection" type="xs:boolean" default="false" use="optional"/>
 </xs:complexType>

See section 5.1 for the full W3C XML Schema ([XMLSCHEMA1] section 2.1).