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.

The following is the WSDL port type specification of the GetSlicerItemList WSDL operation.

 <wsdl:operation name="GetSlicerItemList" xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/">
   <wsdl:input wsaw:Action="http://schemas.microsoft.com/office/Excel/Server/WebServices/ExcelServerInternalService/ExcelServiceSoap/GetSlicerItemList" message="tns:ExcelServiceSoap_GetSlicerItemList_InputMessage" xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"/>
   <wsdl:output wsaw:Action="http://schemas.microsoft.com/office/Excel/Server/WebServices/ExcelServerInternalService/ExcelServiceSoap/GetSlicerItemListResponse" message="tns:ExcelServiceSoap_GetSlicerItemList_OutputMessage" xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"/>
   <wsdl:fault wsaw:Action="http://schemas.microsoft.com/office/Excel/Server/WebServices/ExcelServerInternalService/ExcelServiceSoap/GetSlicerItemListExcelServerMessageFault" name="ExcelServerMessageFault" message="tns:ExcelServiceSoap_GetSlicerItemList_ExcelServerMessageFault_FaultMessage" xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"/>
 </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, then the SlicerItems element of itemList MUST contain a list with all slicer items starting at SlicerItemsOffset.

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

    • If SlicerItemsOffset is equal to -1 then the protocol server will determine the first slicer item in the resulting itemList in the following way:

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

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

    • If the sum of SlicerItemsOffset and SlicerItemsCount is greater than the number of slicer items then itemList MUST be empty.

    • If SlicerItemsCount is equal to -1, the lesser of 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 0 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<40> be one of the values specified in section 2.2.2.1.