3.1.4.27 GetSlicerItemList

  • Article

This operation is used to return the slicer items and formatting information for the slicer visual components that are part of a slicer.

 <wsdl:operation name="GetSlicerItemList">
   <wsdl:input wsam:Action="http://schemas.microsoft.com/office/Excel/Server/WebServices/ExcelServerInternalService/ExcelServiceSoap/GetSlicerItemList" message="tns:ExcelServiceSoap_GetSlicerItemList_InputMessage"/>
   <wsdl:output wsam:Action="http://schemas.microsoft.com/office/Excel/Server/WebServices/ExcelServerInternalService/ExcelServiceSoap/GetSlicerItemListResponse" message="tns:ExcelServiceSoap_GetSlicerItemList_OutputMessage"/>
   <wsdl:fault wsam:Action="http://schemas.microsoft.com/office/Excel/Server/WebServices/ExcelServerInternalService/ExcelServiceSoap/GetSlicerItemListExcelServerMessageFault" name="ExcelServerMessageFault" message="tns:ExcelServiceSoap_GetSlicerItemList_ExcelServerMessageFault_FaultMessage"/>
 </wsdl:operation>

The protocol client sends an ExcelServiceSoap_GetSlicerItemList_InputMessage request message, and the protocol server responds with an ExcelServiceSoap_GetSlicerItemList_OutputMessage response message, as follows:

  • The protocol server returns a SlicerItemList (section 2.2.4.40) in itemList with the following conditions.

    • If the SlicerItemsCount element in SlicerOptions (section 2.2.4.41) is greater than or equal to 0 and less than or equal to the total number of slicer items, the SlicerItems element of itemList MUST contain a list with a number of SlicerItem elements (section 2.2.4.39) equal to the SlicerItemsCount element in SlicerOptions.

    • If SlicerItemsCount element of SlicerOptions is greater than the total number of slicer items, the SlicerItems element of itemList MUST contain a list with all slicer items starting at SlicerItemsOffset.

    • If SlicerItemsOffset is greater than or equal to zero, the list of elements in itemList MUST begin at SlicerItemsOffset.

    • If SlicerItemsOffset is equal to "-1", the protocol server determines the first slicer item in the resulting itemList in the following way:

      • If a call to ApplySlicerSelection was made in the current session, the protocol server uses the value of the SlicerItemsOffset element of the SlicerOptions element of the last call to ApplySlicerSelection.

      • Otherwise, the protocol server uses the value in the startItem attribute in CT_Slicer ([MS-XLSX] section 2.6.68).

    • If the SlicerItemsOffset element of SlicerOptions is greater than the number of slicer items, itemList MUST be empty.

    • If SlicerItemsCount is equal to "-1", the lesser of the total number of items or 5 times the visible number of items is returned.

    • If SlicerItemsOffset is equal to "-1", the protocol server returns a SlicerFormatElementList (section 2.2.4.38) in formatList that MUST contain 10 elements, as specified in section 2.2.4.9. Otherwise, the protocol server MUST return a formatList with zero elements.

In the event of an application error on the protocol server during this operation, a SOAP fault is returned, as specified in section 2.2.2. The Id element of the ExcelServerMessage SHOULD<36> be one of the values specified in section 2.2.2.1.