Share via

2.2.4.41 SlicerOptions

  • Article

Namespace: http://schemas.microsoft.com/office/Excel/Server/WebServices/ExcelServerInternalService/

A container for common information related to a slicer.

 <xs:complexType name="SlicerOptions" xmlns:xs="http://www.w3.org/2001/XMLSchema">
   <xs:sequence>
     <xs:element minOccurs="1" maxOccurs="1" name="SlicerCacheId" type="xs:int"/>
     <xs:element minOccurs="1" maxOccurs="1" name="SlicerViewId" type="xs:int"/>
     <xs:element minOccurs="1" maxOccurs="1" name="SlicerExternalSourceIndex" type="xs:int"/>
     <xs:element minOccurs="1" maxOccurs="1" name="SlicerItemsOffset" type="xs:int"/>
     <xs:element minOccurs="1" maxOccurs="1" name="SlicerItemsCount" type="xs:int"/>
     <xs:element minOccurs="1" maxOccurs="1" name="SlicerClearItems" type="xs:boolean"/>
     <xs:element minOccurs="1" maxOccurs="1" name="SlicerVersion" type="xs:int"/>
     <xs:element minOccurs="1" maxOccurs="1" name="IsNov2" type="xs:boolean"/>
     <xs:element minOccurs="1" maxOccurs="1" name="SlicerViewableHeightNov2" type="xs:int"/>
     <xs:element minOccurs="0" maxOccurs="1" name="SlicerName" type="xs:string"/>
     <xs:element minOccurs="1" maxOccurs="1" name="Options" type="tns:SlicerOptionsBits"/>
     <xs:element minOccurs="0" maxOccurs="1" name="SelectedRanges" type="tns:ArrayOfSlicerItemRange"/>
     <xs:element minOccurs="0" maxOccurs="1" name="UnselectedRanges" type="tns:ArrayOfSlicerItemRange"/>
     <xs:element minOccurs="0" maxOccurs="1" name="SelectedNames" type="tns:ArrayOfString"/>
     <xs:element minOccurs="0" maxOccurs="1" name="UnselectedNames" type="tns:ArrayOfString"/>
   </xs:sequence>
 </xs:complexType>

SlicerCacheId: An identifier that the protocol server uses in combination with SlicerViewId to identify a slicer. MUST be equal to the value of the SlicerCacheId attribute of the CT_Slicer element, as specified in [MS-EXSPXML3] section 2.3.36.

SlicerViewId: An identifier that the protocol server uses in combination with SlicerCacheId to identify a slicer. MUST be equal to the value of the SlicerViewId attribute of the CT_Slicer element, as specified in [MS-EXSPXML3] section 2.3.36.

SlicerExternalSourceIndex: The index of the connected data. MUST be equal to the value of the ExternalSourceIndex attribute of the CT_Slicer element, as specified in [MS-EXSPXML3] section 2.3.36.

SlicerItemsOffset: An index to the slicer item to be retrieved. MUST be greater than or equal to -1. MUST be less than the total number of slicer items.  

SlicerItemsCount: The number of slicer items to fetch. MUST be greater than or equal to -1. The sum of SlicerItemsCount and SlicerItemsOffset MUST be less than the total number of slicer items.

SlicerClearItems: MUST be true if previously selected items will be unselected. MUST be false otherwise.

SlicerVersion: Current version of the slicer on the protocol client. MUST be equal to the value of the Version attribute of the CT_Slicer element, as specified in [MS-EXSPXML3] section 2.3.36.

IsNov2: A value that specifies whether the operation is performed on a named object. MUST be set to true if the operation is being performed on a named object. Otherwise, MUST be set to false.

SlicerViewableHeightNov2: Specifies the height of the slicer in pixels. MUST be ignored by the protocol server when IsNov2 is false. MUST be equal to or greater than 0.  

SlicerName: Name to identify a slicer.

Options: Additional options for the operation to be performed on the slicer.

SelectedRanges:  slicer items to be selected.

UnselectedRanges:  slicer items to be unselected.

SelectedNames: MUST not be used.

UnselectedNames:  MUST not be used.