Share via

2.3.38 CT_Worksheet

  • Article

Referenced by: CT_Workbook

A sheet or a named object in the workbook.

Child Elements:

WorksheetOptions: A collection of settings and options for the sheet (1).

This element MUST be present if any one of the following conditions is true:

  • The NamedRange attribute is false.

  • The NamedRange attribute is true, and the ChartSheet attribute is false.

  • The NamedRange attribute is true, the ChartSheet            attribute is true, and the sheet is displayed right-to-left.

It MUST NOT be present otherwise.

InteractiveReport: A CT_InteractiveReport element (section 2.3.59) that specifies information about an interactive report.

autofilters: A list of AutoFilters.

This element MUST NOT be present if the ChartSheet attribute is true. If the ChartSheet            attribute is false, it MUST be present if any one of the following conditions is true:

  • The NamedRange attribute is false, the Name            attribute is equal to the SheetName element specified in the CommandParameter ([MS-EXSPWS3] section 2.2.4.20) VisibleSheetRangeRequest parameter sent by the protocol client, and one or more AutoFilters are present in the range defined in the CT_Table element (section 2.3.35).

  • The NamedRange attribute is false, the SheetName element specified in the CommandParameter ([MS-EXSPWS3] section 2.2.4.20) VisibleSheetRangeRequest parameter sent by the protocol client is empty, one or more AutoFilters are present in the range defined in the CT_Table element (section 2.3.35), and one of the following conditions is met:

    • The worksheet represented by this element is the active sheet in the workbook, and the worksheet is a visible published sheet.

    • The active sheet in the workbook is not visible or not published, and the worksheet represented by this element is the first visible published sheet in the workbook.

  • The NamedRange attribute is true, and one or more AutoFilters are present in the range defined in the CT_Table element (section 2.3.35).

    It MUST NOT be present otherwise.

PivotTables: A list of PivotTables.

This element MUST NOT be present if the ChartSheet            attribute is true. If the ChartSheet attribute is false, it MUST be present if any one of the following conditions is true:

  • The NamedRange attribute is false, the Name attribute is equal to the SheetName element specified in the CommandParameter ([MS-EXSPWS3] section 2.2.4.20) VisibleSheetRangeRequest parameter sent by the protocol client, and one or more PivotTable elements are present in the range defined in the CT_Table element (section 2.3.35).

  • The NamedRange attribute is false, the SheetName element specified in the CommandParameter ([MS-EXSPWS3] section 2.2.4.20) VisibleSheetRangeRequest parameter sent by the protocol client is empty, one or more PivotTable elements are present in the range defined in the CT_Table element (section 2.3.35), and one of the following conditions is met:

    • The worksheet represented by this element is the active sheet in the workbook, and the worksheet is a visible published sheet.

    • The active sheet in the workbook is not visible or not published, and the worksheet represented by this element is the first visible published sheet in the workbook.

  • The NamedRange attribute is true, and one or more PivotTable elements is present in the range defined in the CT_Table element (section 2.3.35).

    It MUST NOT be present otherwise.

Slicers: A list of slicers.

This element MUST NOT be present if the ChartSheet attribute is true. If the ChartSheet element is false, it MUST be present if any one of the following conditions is true:

  • The NamedRange            attribute is false, the Name            attribute is equal to the SheetName element specified in the CommandParameter ([MS-EXSPWS3] section 2.2.4.20) VisibleSheetRangeRequest parameter sent by the protocol client, and one or more slicers are present in the range defined in the CT_Table element (section 2.3.35).

  • The NamedRange attribute is false, the SheetName element specified in the CommandParameter ([MS-EXSPWS3] section 2.2.4.20) VisibleSheetRangeRequest parameter sent by the protocol client is empty, one or more slicers are present in the range defined in the CT_Table element (section 2.3.35), and one of the following conditions is met:

    • The worksheet represented by this element is the active sheet in the workbook, and the worksheet is a visible published sheet.

    • The active sheet in the workbook is not visible or not published, and the worksheet represented by this element is the first visible published sheet in the workbook.

  • The NamedRange            attribute is true, and one or more slicers are present in the range defined in the CT_Table element.

It MUST NOT be present otherwise.

Hyperlinks: A list of hyperlinks.

This element MUST NOT be present if the ChartSheet attribute is true. If the ChartSheet attribute is false, it MUST be present if any one of the following conditions is true:

  • The NamedRange            attribute is false, the Name            attribute is equal to the SheetName element specified in the CommandParameter ([MS-EXSPWS3] section 2.2.4.20) VisibleSheetRangeRequest parameter sent by the protocol client, and there are one or more hyperlinks present in the range defined in the CT_Table element (section 2.3.35).

  • The NamedRange attribute is false, the SheetName element specified in the CommandParameter ([MS-EXSPWS3] section 2.2.4.20) VisibleSheetRangeRequest parameter sent by the protocol client is empty, there are one or more hyperlinks present in the range defined in the CT_Table element (section 2.3.35), and one of the following conditions is met:

    • The worksheet represented by this element is the active sheet in the workbook, and the worksheet is a visible published sheet.

    • The active sheet in the workbook is not visible or not published, and the worksheet represented by this element is the first visible published sheet in the workbook.

  • The NamedRange            attribute is true, and there are one or more hyperlinks present in the range defined in the CT_Table element (section 2.3.35).

It MUST NOT be present otherwise.

Comments: A list of cell comments.

This element MUST NOT be present if the ChartSheet attribute is true. If the ChartSheet attribute is false, it MUST be present if any one of the following conditions is true:

  • The NamedRange            attribute is false, the Name            attribute is equal to the SheetName element specified in the CommandParameter ([MS-EXSPWS3] section 2.2.4.20) VisibleSheetRangeRequest parameter sent by the protocol client, and there are one or more cell comments present in the range defined in the CT_Table element (section 2.3.35).

  • The NamedRange attribute is false, the SheetName element specified in the CommandParameter ([MS-EXSPWS3] section 2.2.4.20) VisibleSheetRangeRequest parameter sent by the protocol client is empty, there are one or more cell comments present in the range defined in the CT_Table element (section 2.3.35), and one of the following conditions is met:

    • The worksheet represented by this element is the active sheet in the workbook, and the worksheet is a visible published sheet.

    • The active sheet in the workbook is not visible or not published, and the worksheet represented by this element is the first visible published sheet in the workbook.

  • The NamedRange            attribute is true, and there are one or more cell comments present in the range defined in the CT_Table element (section 2.3.35).

It MUST NOT be present otherwise.

Images: A list of worksheet images.

This element MUST be present if any one of the following conditions is true:

  • The ChartSheet            attribute is true, and the Name attribute is equal to the SheetName element specified in the CommandParameter ([MS-EXSPWS3] section 2.2.4.20) VisibleSheetRangeRequest parameter sent by the protocol client.

  • The ChartSheet attribute is true, the SheetName element specified in the CommandParameter ([MS-EXSPWS3] section 2.2.4.20) VisibleSheetRangeRequest parameter sent by the protocol client is empty, and one of the following conditions is met:

    • The chart sheet represented by this element is the active sheet in the workbook, and the chart sheet is a visible published sheet.

    • The active sheet in the workbook is not visible or not published, and the chart sheet represented by this element is the first visible published sheet in the workbook.

  • The NamedRange attribute is false, the Name            attribute is equal to the SheetName element specified in the CommandParameter ([MS-EXSPWS3] section 2.2.4.20) VisibleSheetRangeRequest parameter sent by the protocol client, and one or more worksheet images are present in the range defined in the CT_Table element (section 2.3.35).

  • The NamedRange attribute is false, the SheetName element specified in the CommandParameter ([MS-EXSPWS3] section 2.2.4.20) VisibleSheetRangeRequest parameter sent by the protocol client is empty, one or more worksheet images are present in the range defined in the CT_Table element (section 2.3.35), and one of the following conditions is met:

    • The worksheet represented by this element is the active sheet in the workbook, and the worksheet is a visible published sheet.

    • The active sheet in the workbook is not visible or not published, and the worksheet represented by this element is the first visible published sheet in the workbook.

  • The NamedRange attribute is true, and one or more worksheet images are present in the range specified in the CT_Table element (section 2.3.35).

It MUST NOT be present otherwise.

WebExtensions: A CT_WebExtensions element (section 2.3.55) that specifies a list of Office Web Extensions present in the range.

This element MUST be present if any one of the following conditions is true:

  • The NamedRange            attribute is false, the Name            attribute is equal to the SheetName element specified in the CommandParameter ([MS-EXSPWS3] section 2.2.4.20) VisibleSheetRangeRequest parameter sent by the protocol client, and one or more Office Web Extensions are present in the range defined in the CT_Table element (section 2.3.35).

  • The NamedRange attribute is false, the SheetName element specified in the CommandParameter ([MS-EXSPWS3] section 2.2.4.20) VisibleSheetRangeRequest parameter sent by the protocol client is empty, one or more Office Web Extensions are present in the range defined in the CT_Table element (section 2.3.35), and one of the following conditions is met:

    • The worksheet represented by this element is the active sheet in the workbook, and the worksheet is a visible published sheet.

    • The active sheet in the workbook is not visible or not published, and the worksheet represented by this element is the first visible published sheet in the workbook.

  • The NamedRange            attribute is true, and one or more Office Web Extensions are present in the range defined in the CT_Table element (section 2.3.35).

It MUST NOT be present otherwise.

Table: This element contains information about a range, represented in tabular format.

This element MUST NOT be present if the ChartSheet            attribute is true. If the ChartSheet element is false, it MUST be present if any one of the following conditions is true:

  • The NamedRange attribute is false, and the Name            attribute is equal to the SheetName element specified in the CommandParameter ([MS-EXSPWS3] section 2.2.4.20) VisibleSheetRangeRequest parameter sent by the protocol client.

  • The NamedRange attribute is false, the SheetName element specified in the CommandParameter ([MS-EXSPWS3] section 2.2.4.20) VisibleSheetRangeRequest parameter sent by the protocol client is empty, and one of the following conditions is met:

    • The worksheet represented by this element is the active sheet in the workbook, and the worksheet is a visible published sheet.

    • The active sheet in the workbook is not visible or not published, and the worksheet represented by this element is the first visible published sheet in the workbook.

  • The NamedRange attribute is true.

It MUST NOT be present otherwise.

Attributes:

ActiveSheet: Specifies whether the Worksheet element is the active sheet. This attribute MUST be true if this Worksheet is the active sheet and MUST NOT be present otherwise. There MUST be only one Worksheet element in the workbook in which this attribute is set to true, across the list of worksheets.

ChartSheet: Specifies whether the Worksheet element is a chart sheet or a named object of type chart. This attribute MUST be set to true if the Worksheet element represents a chart sheet. If it represents a named object of type chart, this attribute (2) MUST NOT be present.

InteractiveReportSheet: Indicates whether the Worksheet element is an interactive report sheet. MUST be true if the Worksheet element is an interactive report sheet. Otherwise, it MUST be false.

ContainsOlapSlicer: Specifies whether the worksheet contains any slicer based on OLAP data.

Name: The name of the sheet or the named object represented by the Worksheet element. The type of this attribute MUST be ST_SheetName (section 2.4.23) if the NamedRange attribute is false; it MUST be ST_ObjectName (section 2.4.22) if the NamedRange attribute is true. This attribute (2) MUST be unique across the list of worksheets in the workbook.

NameRTL: Specifies whether the sheet name is in right-to-left format. This attribute MUST be set to true when the sheet name is in right-to-left format. This attribute MUST NOT be present if the sheet name is not in right-to-left format.

NamedRange: Specifies whether the Worksheet element represents a named object. This attribute MUST be set to true if the Worksheet element represents a named object. This attribute MUST NOT be present if the Worksheet element does not represent a named object.

SheetName: The name of the sheet on which the named object resides, if the Worksheet element is a named object. This attribute MUST be present if the NamedRange attribute is true; otherwise, this attribute (2) MUST NOT be present.

Visible: Specifies whether the worksheet is visible.

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

 <xs:complexType name="CT_Worksheet">
   <xs:sequence>
     <xs:element name="WorksheetOptions" minOccurs="0" maxOccurs="1" type="CT_WorksheetOptions"/>
     <xs:element name="InteractiveReport" minOccurs="0" maxOccurs="1" type="CT_InteractiveReport"/>
     <xs:element name="autofilters" minOccurs="0" maxOccurs="1" type="CT_autofilters"/>
     <xs:element name="PivotTables" minOccurs="0" maxOccurs="1" type="CT_PivotTables"/>
     <xs:element name="Slicers" maxOccurs="1" minOccurs="0" type="CT_Slicers"/>
     <xs:element name="Hyperlinks" minOccurs="0" maxOccurs="1" type="CT_Hyperlinks"/>
     <xs:element name="Comments" minOccurs="0" maxOccurs="1" type="CT_Comments"/>
     <xs:element name="Images" maxOccurs="1" minOccurs="0" type="CT_Images"/>
     <xs:element name="WebExtensions" maxOccurs="1" minOccurs="0" type="CT_WebExtensions"/>
     <xs:element name="Table" minOccurs="0" maxOccurs="1" type="CT_Table"/>
   </xs:sequence>
   <xs:attribute name="ActiveSheet" type="xs:boolean" default="false" use="optional"/>
   <xs:attribute name="ChartSheet" type="xs:boolean" default="false" use="optional"/>
   <xs:attribute name="InteractiveReportSheet" type="xs:boolean" default="false" use="optional"/>
   <xs:attribute name="ContainsOlapSlicer" type="xs:boolean" default="false" use="optional"/>
   <xs:attribute name="Name" type="ST_SheetOrObjectName" use="required"/>
   <xs:attribute name="NameRTL" type="xs:boolean" default="false" use="optional"/>
   <xs:attribute name="NamedRange" type="xs:boolean" default="false" use="optional"/>
   <xs:attribute name="SheetName" type="ST_SheetName" use="optional"/>
   <xs:attribute name="Visible" type="ST_enmWorksheetVisibilityState" default="Visible" use="optional"/>
 </xs:complexType>

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