DownloadReportDefinitionRequest 类

应用到: CRM 2015 on-prem, CRM Online

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）成员都是线程安全成员。不保证任何实例成员是线程安全成员。

平台

开发平台

Windows Vista、Windows Server 2003 和

目标平台

Windows Vista,Windows XP

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.
© 2014 Microsoft Corporation. All rights reserved.