DownloadReportDefinitionRequest 類別

Contains the data that is needed to download a report definition.

命名空間: Microsoft.Crm.Sdk.Messages
組件: Microsoft.Crm.Sdk.Proxy (在 Microsoft.Crm.Sdk.Proxy.dll 中)

語法

'宣告
<DataContractAttribute(Namespace:="https://schemas.microsoft.com/crm/2011/Contracts")> _
Public NotInheritable Class DownloadReportDefinitionRequest
    Inherits OrganizationRequest

[DataContractAttribute(Namespace="https://schemas.microsoft.com/crm/2011/Contracts")] 
public sealed class DownloadReportDefinitionRequest : OrganizationRequest

範例

The following example shows how to use this message. For this sample to work correctly, you must be connected to the server to get an IOrganizationService interface. For the complete sample, see the link later in this topic.

         // Query for an an existing report: Account Overview. This is a default report in Microsoft Dynamics CRM.                    
         QueryByAttribute reportQuery = new QueryByAttribute(Report.EntityLogicalName);
         reportQuery.AddAttributeValue("name", "Account Overview");
         reportQuery.ColumnSet = new ColumnSet("reportid");
         
// Get the report.
EntityCollection retrieveReports = _serviceProxy.RetrieveMultiple(reportQuery);
    
// Convert retrieved Entity to a report
Report retrievedReport = (Report)retrieveReports.Entities[0];
         Console.WriteLine("Retrieved the 'Account Overview' report.");
    
// Use the Download Report Definition message.
DownloadReportDefinitionRequest rdlRequest = new DownloadReportDefinitionRequest
{
             ReportId = retrievedReport.ReportId.Value
         };

DownloadReportDefinitionResponse rdlResponse = (DownloadReportDefinitionResponse)_serviceProxy.Execute(rdlRequest);

         // Get the current directory path.
         _currentDirectoryPath = Directory.GetCurrentDirectory();

// Access the xml data and save to disk
XmlTextWriter reportDefinitionFile = new XmlTextWriter( _currentDirectoryPath + "\\NewReport.rdl", System.Text.Encoding.UTF8);
reportDefinitionFile.WriteRaw(rdlResponse.BodyText);
reportDefinitionFile.Close();

         if (File.Exists(_currentDirectoryPath + "\\NewReport.rdl"))
{
             Console.WriteLine("Downloaded the report definition (NewReport.rdl) to '{0}'.", _currentDirectoryPath.ToString());
}

備註

Message Availability

如果要使用此訊息，呼叫端必須連線至伺服器。

Usage

Pass an instance of this class to the Execute method, which returns an instance of DownloadReportDefinitionResponse.

Privileges and Access Rights

To perform this action, the caller must have privileges on the report entity and access rights on the record specified in the ReportId. For a complete list of the privileges required, see DownloadReportDefinition Privileges.

Notes for Callers

The response from the message is a UTF-8 encoded XML document in the form of a string that represents the entire content of the report definition (RDL) file.

繼承階層

System.Object
   Microsoft.Xrm.Sdk.OrganizationRequest
    Microsoft.Crm.Sdk.Messages.DownloadReportDefinitionRequest

執行緒安全

此類型的任何公用靜態 (Visual Basic 中的 Shared) 成員都具備執行緒安全。任何執行個體成員都不保證具備執行緒安全。

平台

Development Platforms

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see System Requirements.

Target Platforms

Windows Server 2008、Windows Server 2012、Windows 7

Change History

請參閱

參照

DownloadReportDefinitionRequest 成員
Microsoft.Crm.Sdk.Messages 命名空間
DownloadReportDefinitionResponse

其他資源

Report Entities
Report Entity Messages and Methods
Sample: Download Report Definition

Send comments about this topic to Microsoft.
© 2015 Microsoft. All rights reserved.