ReportExecutionService.Sort Method

Applies or removes a sort for the execution based on a user sort action.

Namespace:  ReportExecution2005
Assembly:  ReportExecution2005 (in ReportExecution2005.dll)

Syntax

'Declaration
<SoapHeaderAttribute("TrustedUserHeaderValue")> _
<SoapHeaderAttribute("ServerInfoHeaderValue", Direction := SoapHeaderDirection.Out)> _
<SoapHeaderAttribute("ExecutionHeaderValue")> _
<SoapDocumentMethodAttribute("http://schemas.microsoft.com/sqlserver/2005/06/30/reporting/reportingservices/Sort", RequestNamespace := "http://schemas.microsoft.com/sqlserver/2005/06/30/reporting/reportingservices",  _
    ResponseNamespace := "http://schemas.microsoft.com/sqlserver/2005/06/30/reporting/reportingservices",  _
    Use := SoapBindingUse.Literal, ParameterStyle := SoapParameterStyle.Wrapped)> _
Public Function Sort ( _
    SortItem As String, _
    Direction As SortDirectionEnum, _
    Clear As Boolean, _
    <OutAttribute> ByRef ReportItem As String, _
    <OutAttribute> ByRef NumPages As Integer _
) As Integer
'Usage
Dim instance As ReportExecutionService
Dim SortItem As String
Dim Direction As SortDirectionEnum
Dim Clear As Boolean
Dim ReportItem As String
Dim NumPages As Integer
Dim returnValue As Integer

returnValue = instance.Sort(SortItem, _
    Direction, Clear, ReportItem, NumPages)
[SoapHeaderAttribute("TrustedUserHeaderValue")]
[SoapHeaderAttribute("ServerInfoHeaderValue", Direction = SoapHeaderDirection.Out)]
[SoapHeaderAttribute("ExecutionHeaderValue")]
[SoapDocumentMethodAttribute("http://schemas.microsoft.com/sqlserver/2005/06/30/reporting/reportingservices/Sort", RequestNamespace = "http://schemas.microsoft.com/sqlserver/2005/06/30/reporting/reportingservices", 
    ResponseNamespace = "http://schemas.microsoft.com/sqlserver/2005/06/30/reporting/reportingservices", 
    Use = SoapBindingUse.Literal, ParameterStyle = SoapParameterStyle.Wrapped)]
public int Sort(
    string SortItem,
    SortDirectionEnum Direction,
    bool Clear,
    out string ReportItem,
    out int NumPages
)
[SoapHeaderAttribute(L"TrustedUserHeaderValue")]
[SoapHeaderAttribute(L"ServerInfoHeaderValue", Direction = SoapHeaderDirection::Out)]
[SoapHeaderAttribute(L"ExecutionHeaderValue")]
[SoapDocumentMethodAttribute(L"http://schemas.microsoft.com/sqlserver/2005/06/30/reporting/reportingservices/Sort", RequestNamespace = L"http://schemas.microsoft.com/sqlserver/2005/06/30/reporting/reportingservices", 
    ResponseNamespace = L"http://schemas.microsoft.com/sqlserver/2005/06/30/reporting/reportingservices", 
    Use = SoapBindingUse::Literal, ParameterStyle = SoapParameterStyle::Wrapped)]
public:
int Sort(
    String^ SortItem, 
    SortDirectionEnum Direction, 
    bool Clear, 
    [OutAttribute] String^% ReportItem, 
    [OutAttribute] int% NumPages
)
[<SoapHeaderAttribute("TrustedUserHeaderValue")>]
[<SoapHeaderAttribute("ServerInfoHeaderValue", Direction = SoapHeaderDirection.Out)>]
[<SoapHeaderAttribute("ExecutionHeaderValue")>]
[<SoapDocumentMethodAttribute("http://schemas.microsoft.com/sqlserver/2005/06/30/reporting/reportingservices/Sort", RequestNamespace = "http://schemas.microsoft.com/sqlserver/2005/06/30/reporting/reportingservices", 
    ResponseNamespace = "http://schemas.microsoft.com/sqlserver/2005/06/30/reporting/reportingservices", 
    Use = SoapBindingUse.Literal, ParameterStyle = SoapParameterStyle.Wrapped)>]
member Sort : 
        SortItem:string * 
        Direction:SortDirectionEnum * 
        Clear:bool * 
        ReportItem:string byref * 
        NumPages:int byref -> int 
public function Sort(
    SortItem : String, 
    Direction : SortDirectionEnum, 
    Clear : boolean, 
    ReportItem : String, 
    NumPages : int
) : int

Parameters

  • SortItem
    Type: System.String
    The ID of the report item on which to sort.
  • Clear
    Type: System.Boolean
    A Boolean value that indicates whether all other existing sorts should be cleared. The default is false.
  • ReportItem
    Type: System.String%
    [out] The ID of the item on the page used for positioning in the viewing area.
  • NumPages
    Type: System.Int32%
    [out] The new total number of pages in the report.

Return Value

Type: System.Int32
An integer value containing the new page number on which the item passed in the ReportItem parameter falls.

Remarks

The table below shows header and permissions information on this operation.

SOAP Header Usage

(In) TrustedUserHeaderValue

(In) ExecutionHeaderValue

(Out) ServerInfoHeaderValue

Native Mode Required Permissions

None

SharePoint Mode Required Permissions

None