Class ReportManager

Namespace

Lers.Reports

Assembly

Lers.Reports.dll

Предоставляет интерфейс для работы с отчетами.

public class ReportManager : ServerObject, IDisposable

Inheritance

object

ServerObject

ReportManager

Implements

IDisposable

Inherited Members

ServerObject.Server

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

EnumerableExtensions.Yield<T>(T)

CastExtensions.CastTo<T>(object)

Constructors

ReportManager(LersServer)

Инициализирует новый экземпляр класса ReportManager.

public ReportManager(LersServer server)

Parameters

server LersServer

Экземпляр LersServer, для взаимодействия с сервером ЛЭРС УЧЕТ.

Fields

ReportParameterManager

Пользовательские параметры используемые при формировании отчета.

public ReportParameterManager ReportParameterManager

Field Value

ReportParameterManager

ReportParameterPropertyManager

Свойства пользовательских параметров.

public ReportParameterPropertyManager ReportParameterPropertyManager

Field Value

ReportParameterPropertyManager

Methods

DeletePreparedReport(int)

Удаление отчетной формы без проверки ее использования.

public void DeletePreparedReport(int id)

Parameters

id int

ID удаляемой отчетной формы.

Dispose()

Освобождает занятые ресурсы.

public void Dispose()

GenerateAccountSummaryActivityReportAsync(int, DateTime, DateTime, ReportOptions, ReportParameter[], int[], CancellationToken)

Формирует отчет о действиях пользователей.

public Task<GeneratedReport> GenerateAccountSummaryActivityReportAsync(int reportId, DateTime startDate, DateTime endDate, ReportOptions reportOptions = null, ReportParameter[] reportParameters = null, int[] idList = null, CancellationToken cancellationToken = default)

Parameters

reportId int

Идентификатор отчета.

startDate DateTime

Начальная дата периода.

endDate DateTime

Конечная дата периода.

reportOptions ReportOptions

Дополнительные параметры отчета задаваемые пользователем.

reportParameters ReportParameter[]

Массив пользовательских параметров, которые могут использоваться в скриптах отчетной формы.

idList int[]

Список идентификаторов объектов учета.

cancellationToken CancellationToken

Токен отмены, который может использоваться для отмены асинхронной операции.

Returns

Task<GeneratedReport>

Экземпляр класса GeneratedReport

GenerateActAsync(int, ReportEntity, int, DateTime?, DateTime?, ReportOptions, ReportParameter[], CancellationToken)

Формирует отчет "Акт" асинхронно.

public Task<GeneratedReport> GenerateActAsync(int entityId, ReportEntity reportEntity, int reportId, DateTime? startDate = null, DateTime? endDate = null, ReportOptions reportOptions = null, ReportParameter[] reportParameters = null, CancellationToken cancellationToken = default)

Parameters

entityId int

Идентификатор точки учета, для которой формируется акт.

reportEntity ReportEntity

Тип объектов, которые используются в отчетной форме.

reportId int

ID отчет для акта.

startDate DateTime?

Начальная дата периода.

endDate DateTime?

Конечная дата периода.

reportOptions ReportOptions

Дополнительные параметры отчета задаваемые пользователем ReportOptions.

reportParameters ReportParameter[]

Массив пользовательских параметров ReportParameter, которые могут использоваться в скриптах отчетной формы.

cancellationToken CancellationToken

Токен отмены CancellationToken, который может использоваться для отмены асинхронной операции.

Returns

Task<GeneratedReport>

Экземпляр класса GeneratedReport

GenerateActRawAsync(int, ReportEntity, int, DateTime?, DateTime?, ReportOptions, ReportParameter[], CancellationToken)

Формирует отчет "Акт" асинхронно.

public Task<GeneratedReportRaw> GenerateActRawAsync(int entityId, ReportEntity reportEntity, int reportId, DateTime? startDate = null, DateTime? endDate = null, ReportOptions reportOptions = null, ReportParameter[] reportParameters = null, CancellationToken cancellationToken = default)

Parameters

entityId int

Идентификатор точки учета, для которой формируется акт.

reportEntity ReportEntity

Тип объектов, которые используются в отчетной форме.

reportId int

ID отчет для акта.

startDate DateTime?

Начальная дата периода.

endDate DateTime?

Конечная дата периода.

reportOptions ReportOptions

Дополнительные параметры отчета задаваемые пользователем ReportOptions.

reportParameters ReportParameter[]

Массив пользовательских параметров ReportParameter, которые могут использоваться в скриптах отчетной формы.

cancellationToken CancellationToken

Токен отмены CancellationToken, который может использоваться для отмены асинхронной операции.

Returns

Task<GeneratedReportRaw>

Сформированный отчёт.

GenerateBalanceHeatReportAsync(int, int, DateTime, DateTime, DeviceDataType, ReportOptions, ReportParameter[], CancellationToken)

Формирует баланс по воде, тепловой энергии и электроэнергии для балансовой группы асинхронно.

public Task<GeneratedReport> GenerateBalanceHeatReportAsync(int balanceGroupId, int reportId, DateTime startDate, DateTime endDate, DeviceDataType dataType, ReportOptions reportOptions = null, ReportParameter[] reportParameters = null, CancellationToken cancellationToken = default)

Parameters

balanceGroupId int

Идентификатор балансовой группы.

reportId int

Идентификатор отчета.

startDate DateTime

Начальная дата периода.

endDate DateTime

Конечная дата периода.

dataType DeviceDataType

Тип данных DeviceDataType.

reportOptions ReportOptions

Дополнительные параметры отчета задаваемые пользователем ReportOptions.

reportParameters ReportParameter[]

Массив пользовательских параметров ReportParameter, которые могут использоваться в скриптах отчетной формы.

cancellationToken CancellationToken

Токен отмены CancellationToken, который может использоваться для отмены асинхронной операции.

Returns

Task<GeneratedReport>

Экземпляр класса GeneratedReport

GenerateBalanceHeatReportRawAsync(int, int, DateTime, DateTime, DeviceDataType, ReportOptions, ReportParameter[], CancellationToken)

Формирует баланс по воде, тепловой энергии и электроэнергии для балансовой группы асинхронно.

public Task<GeneratedReportRaw> GenerateBalanceHeatReportRawAsync(int balanceGroupId, int reportId, DateTime startDate, DateTime endDate, DeviceDataType dataType, ReportOptions reportOptions = null, ReportParameter[] reportParameters = null, CancellationToken cancellationToken = default)

Parameters

balanceGroupId int

Идентификатор балансовой группы.

reportId int

Идентификатор отчета.

startDate DateTime

Начальная дата периода.

endDate DateTime

Конечная дата периода.

dataType DeviceDataType

Тип данных DeviceDataType.

reportOptions ReportOptions

Дополнительные параметры отчета задаваемые пользователем ReportOptions.

reportParameters ReportParameter[]

Массив пользовательских параметров ReportParameter, которые могут использоваться в скриптах отчетной формы.

cancellationToken CancellationToken

Токен отмены, который может использоваться для отмены асинхронной операции.

Returns

Task<GeneratedReportRaw>

Сформированный отчёт.

GenerateBalanceReportAsync(int[], int, DateTime, DateTime, DeviceDataType, ReportOptions, ReportParameter[], CancellationToken)

Формирует балансовый отчет по дому асинхронно.

public Task<GeneratedReport> GenerateBalanceReportAsync(int[] idList, int reportId, DateTime startDate, DateTime endDate, DeviceDataType dataType, ReportOptions reportOptions = null, ReportParameter[] reportParameters = null, CancellationToken cancellationToken = default)

Parameters

idList int[]

Список идентификаторов домов.

reportId int

Идентификатор отчетной формы.

startDate DateTime

Начальная дата периода.

endDate DateTime

Конечная дата периода.

dataType DeviceDataType

Тип данных DeviceDataType.

reportOptions ReportOptions

Дополнительные параметры отчета задаваемые пользователем ReportOptions.

reportParameters ReportParameter[]

Массив пользовательских параметров ReportParameter, которые могут использоваться в скриптах отчетной формы.

cancellationToken CancellationToken

Токен отмены CancellationToken, который может использоваться для отмены асинхронной операции.

Returns

Task<GeneratedReport>

Экземпляр класса GeneratedReport

GenerateBalanceReportRawAsync(int[], int, DateTime, DateTime, DeviceDataType, ReportOptions, ReportParameter[], CancellationToken)

Формирует балансовый отчет по дому асинхронно.

public Task<GeneratedReportRaw> GenerateBalanceReportRawAsync(int[] idList, int reportId, DateTime startDate, DateTime endDate, DeviceDataType dataType, ReportOptions reportOptions = null, ReportParameter[] reportParameters = null, CancellationToken cancellationToken = default)

Parameters

idList int[]

Список идентификаторов домов.

reportId int

Идентификатор отчетной формы.

startDate DateTime

Начальная дата периода.

endDate DateTime

Конечная дата периода.

dataType DeviceDataType

Тип данных DeviceDataType.

reportOptions ReportOptions

Дополнительные параметры отчета задаваемые пользователем ReportOptions.

reportParameters ReportParameter[]

Массив пользовательских параметров ReportParameter, которые могут использоваться в скриптах отчетной формы.

cancellationToken CancellationToken

Токен отмены, который может использоваться для отмены асинхронной операции.

Returns

Task<GeneratedReportRaw>

Сформированный отчёт.

GenerateBalanceSummaryReportAsync(int[], int, DateTime, DateTime, DeviceDataType, ReportOptions, ReportParameter[], CancellationToken)

Формирует сводный балансовый отчет по домам асинхронно.

public Task<GeneratedReport> GenerateBalanceSummaryReportAsync(int[] idList, int reportId, DateTime startDate, DateTime endDate, DeviceDataType dataType, ReportOptions reportOptions = null, ReportParameter[] reportParameters = null, CancellationToken cancellationToken = default)

Parameters

idList int[]

Массив идентификаторов сущностей.

reportId int

Идентификатор отчета.

startDate DateTime

Начальная дата периода.

endDate DateTime

Конечная дата периода.

dataType DeviceDataType

Тип данных DeviceDataType.

reportOptions ReportOptions

Дополнительные параметры отчета задаваемые пользователем ReportOptions.

reportParameters ReportParameter[]

Массив пользовательских параметров ReportParameter, которые могут использоваться в скриптах отчетной формы.

cancellationToken CancellationToken

Токен отмены CancellationToken, который может использоваться для отмены асинхронной операции.

Returns

Task<GeneratedReport>

Экземпляр класса GeneratedReport

GenerateBalanceSummaryReportRawAsync(int[], int, DateTime, DateTime, DeviceDataType, ReportOptions, ReportParameter[], CancellationToken)

Формирует сводный балансовый отчет по домам асинхронно.

public Task<GeneratedReportRaw> GenerateBalanceSummaryReportRawAsync(int[] idList, int reportId, DateTime startDate, DateTime endDate, DeviceDataType dataType, ReportOptions reportOptions = null, ReportParameter[] reportParameters = null, CancellationToken cancellationToken = default)

Parameters

idList int[]

Массив идентификаторов сущностей.

reportId int

Идентификатор отчета.

startDate DateTime

Начальная дата периода.

endDate DateTime

Конечная дата периода.

dataType DeviceDataType

Тип данных DeviceDataType.

reportOptions ReportOptions

Дополнительные параметры отчета задаваемые пользователем ReportOptions.

reportParameters ReportParameter[]

Массив пользовательских параметров ReportParameter, которые могут использоваться в скриптах отчетной формы.

cancellationToken CancellationToken

Токен отмены, который может использоваться для отмены асинхронной операции.

Returns

Task<GeneratedReportRaw>

Сформированный отчёт.

GenerateCalibrationReport(int, DateTime, DateTime, ReportOptions, ReportParameter[], CancellationToken)

Формирует синхронно отчет о сроках поверки.

public XtraReport GenerateCalibrationReport(int reportId, DateTime startDate, DateTime endDate, ReportOptions reportOptions = null, ReportParameter[] reportParameters = null, CancellationToken cancellationToken = default)

Parameters

reportId int

ID отчета.

startDate DateTime

Начальная дата периода.

endDate DateTime

Конечная дата периода.

reportOptions ReportOptions

Дополнительные параметры отчета задаваемые пользователем ReportOptions.

reportParameters ReportParameter[]

Массив пользовательских параметров ReportParameter, которые могут использоваться в скриптах отчетной формы.

cancellationToken CancellationToken

Токен отмены CancellationToken, который может использоваться для отмены асинхронной операции.

Returns

XtraReport

Экземпляр класса DevExpress.XtraReports.UI.XtraReport

GenerateCalibrationReportAsync(int, DateTime, DateTime, ReportOptions, ReportParameter[], CancellationToken)

Формирует отчет о сроках поверки асинхронно.

public Task<GeneratedReport> GenerateCalibrationReportAsync(int reportId, DateTime startDate, DateTime endDate, ReportOptions reportOptions = null, ReportParameter[] reportParameters = null, CancellationToken cancellationToken = default)

Parameters

reportId int

ID отчета.

startDate DateTime

Начальная дата периода.

endDate DateTime

Конечная дата периода.

reportOptions ReportOptions

Дополнительные параметры отчета задаваемые пользователем ReportOptions.

reportParameters ReportParameter[]

Массив пользовательских параметров ReportParameter, которые могут использоваться в скриптах отчетной формы.

cancellationToken CancellationToken

Токен отмены CancellationToken, который может использоваться для отмены асинхронной операции.

Returns

Task<GeneratedReport>

Экземпляр класса GeneratedReport

GenerateCalibrationReportRawAsync(int, DateTime, DateTime, ReportOptions, ReportParameter[], CancellationToken)

Формирует отчет о сроках поверки асинхронно.

public Task<GeneratedReportRaw> GenerateCalibrationReportRawAsync(int reportId, DateTime startDate, DateTime endDate, ReportOptions reportOptions = null, ReportParameter[] reportParameters = null, CancellationToken cancellationToken = default)

Parameters

reportId int

ID отчета.

startDate DateTime

Начальная дата периода.

endDate DateTime

Конечная дата периода.

reportOptions ReportOptions

Дополнительные параметры отчета задаваемые пользователем ReportOptions.

reportParameters ReportParameter[]

Массив пользовательских параметров ReportParameter, которые могут использоваться в скриптах отчетной формы.

cancellationToken CancellationToken

Токен отмены, который может использоваться для отмены асинхронной операции.

Returns

Task<GeneratedReportRaw>

Сформированный отчёт.

GenerateCommunalMeasurePointSummaryReport(int, int, DateTime, DateTime, DeviceDataType, ReportOptions, ReportParameter[], CancellationToken)

Формирует синхронно сводный отчет по квартирным точкам учета дома.

public XtraReport GenerateCommunalMeasurePointSummaryReport(int houseId, int reportId, DateTime startDate, DateTime endDate, DeviceDataType dataType, ReportOptions reportOptions = null, ReportParameter[] reportParameters = null, CancellationToken cancellationToken = default)

Parameters

houseId int

Идентификатор дома, по квартирам которого формируется сводный отчет.

reportId int

Идентификатор отчета.

startDate DateTime

Начальная дата периода.

endDate DateTime

Конечная дата периода.

dataType DeviceDataType

Тип данных DeviceDataType.

reportOptions ReportOptions

Дополнительные параметры отчета задаваемые пользователем ReportOptions.

reportParameters ReportParameter[]

Массив пользовательских параметров ReportParameter, которые могут использоваться в скриптах отчетной формы.

cancellationToken CancellationToken

Токен отмены CancellationToken, который может использоваться для отмены асинхронной операции.

Returns

XtraReport

Экземпляр класса DevExpress.XtraReports.UI.XtraReport

GenerateCommunalMeasurePointSummaryReportAsync(int, int, DateTime, DateTime, DeviceDataType, ReportOptions, ReportParameter[], CancellationToken)

Формирует сводный отчет по квартирным точкам учета дома асинхронно.

public Task<GeneratedReport> GenerateCommunalMeasurePointSummaryReportAsync(int houseId, int reportId, DateTime startDate, DateTime endDate, DeviceDataType dataType, ReportOptions reportOptions = null, ReportParameter[] reportParameters = null, CancellationToken cancellationToken = default)

Parameters

houseId int

Идентификатор дома, по квартирам которого формируется сводный отчет.

reportId int

Идентификатор отчета.

startDate DateTime

Начальная дата периода.

endDate DateTime

Конечная дата периода.

dataType DeviceDataType

Тип данных DeviceDataType.

reportOptions ReportOptions

Дополнительные параметры отчета задаваемые пользователем ReportOptions.

reportParameters ReportParameter[]

Массив пользовательских параметров ReportParameter, которые могут использоваться в скриптах отчетной формы.

cancellationToken CancellationToken

Токен отмены CancellationToken, который может использоваться для отмены асинхронной операции.

Returns

Task<GeneratedReport>

Экземпляр класса GeneratedReport

GenerateCompareMeasurePointConsumptionReportAsync(int[], int, DeviceDataType, ReportOptions, ReportParameter[], CancellationToken)

Формирует сводный отчет по сравнению потребления точек учета асинхронно.

public Task<GeneratedReport> GenerateCompareMeasurePointConsumptionReportAsync(int[] idList, int reportId, DeviceDataType dataType, ReportOptions reportOptions = null, ReportParameter[] reportParameters = null, CancellationToken cancellationToken = default)

Parameters

idList int[]

Список идентификаторов сущностей.

reportId int

Идентификатор отчета.

dataType DeviceDataType

Тип данных DeviceDataType.

reportOptions ReportOptions

Дополнительные параметры отчета задаваемые пользователем ReportOptions. В них должны быть заданы даты начала и окончания сравниваемых периодов.

reportParameters ReportParameter[]

Массив пользовательских параметров ReportParameter, которые могут использоваться в скриптах отчетной формы.

cancellationToken CancellationToken

Токен отмены CancellationToken, который может использоваться для отмены асинхронной операции.

Returns

Task<GeneratedReport>

Экземпляр класса GeneratedReport

GenerateCompareMeasurePointConsumptionReportRawAsync(int[], int, DeviceDataType, ReportOptions, ReportParameter[], CancellationToken)

Формирует сводный отчет по сравнению потребления точек учета асинхронно.

public Task<GeneratedReportRaw> GenerateCompareMeasurePointConsumptionReportRawAsync(int[] idList, int reportId, DeviceDataType dataType, ReportOptions reportOptions = null, ReportParameter[] reportParameters = null, CancellationToken cancellationToken = default)

Parameters

idList int[]

Список идентификаторов сущностей.

reportId int

Идентификатор отчета.

dataType DeviceDataType

Тип данных DeviceDataType.

reportOptions ReportOptions

Дополнительные параметры отчета задаваемые пользователем ReportOptions. В них должны быть заданы даты начала и окончания сравниваемых периодов.

reportParameters ReportParameter[]

Массив пользовательских параметров ReportParameter, которые могут использоваться в скриптах отчетной формы.

cancellationToken CancellationToken

Токен отмены, который может использоваться для отмены асинхронной операции.

Returns

Task<GeneratedReportRaw>

Сформированный отчёт.

GenerateCompareNodeConsumptionReportAsync(int[], int, DeviceDataType, ReportOptions, ReportParameter[], CancellationToken)

Формирует сводный отчет по сравнению потребления объектов учета асинхронно.

public Task<GeneratedReport> GenerateCompareNodeConsumptionReportAsync(int[] idList, int reportId, DeviceDataType dataType, ReportOptions reportOptions = null, ReportParameter[] reportParameters = null, CancellationToken cancellationToken = default)

Parameters

idList int[]

Список идентификаторов сущностей.

reportId int

Идентификатор отчета.

dataType DeviceDataType

Тип данных DeviceDataType.

reportOptions ReportOptions

Дополнительные параметры отчета задаваемые пользователем ReportOptions. В них должны быть заданы даты начала и окончания сравниваемых периодов.

reportParameters ReportParameter[]

Массив пользовательских параметров ReportParameter, которые могут использоваться в скриптах отчетной формы.

cancellationToken CancellationToken

Токен отмены CancellationToken, который может использоваться для отмены асинхронной операции.

Returns

Task<GeneratedReport>

Экземпляр класса GeneratedReport

GenerateCompareNodeConsumptionReportRawAsync(int[], int, DeviceDataType, ReportOptions, ReportParameter[], CancellationToken)

Формирует сводный отчет по сравнению потребления объектов учета асинхронно.

public Task<GeneratedReportRaw> GenerateCompareNodeConsumptionReportRawAsync(int[] idList, int reportId, DeviceDataType dataType, ReportOptions reportOptions = null, ReportParameter[] reportParameters = null, CancellationToken cancellationToken = default)

Parameters

idList int[]

Список идентификаторов сущностей.

reportId int

Идентификатор отчета.

dataType DeviceDataType

Тип данных DeviceDataType.

reportOptions ReportOptions

Дополнительные параметры отчета задаваемые пользователем ReportOptions. В них должны быть заданы даты начала и окончания сравниваемых периодов.

reportParameters ReportParameter[]

Массив пользовательских параметров ReportParameter, которые могут использоваться в скриптах отчетной формы.

cancellationToken CancellationToken

Токен отмены, который может использоваться для отмены асинхронной операции.

Returns

Task<GeneratedReportRaw>

Сформированный отчёт.

GenerateConsumptionParametersReport(MeasurePoint[], DateTime, DateTime, ReportOptions, ReportParameter[], CancellationToken)

Формирует параметры потребления точек учета синхронно.

public XtraReport GenerateConsumptionParametersReport(MeasurePoint[] measurePoints, DateTime startDate, DateTime endDate, ReportOptions reportOptions = null, ReportParameter[] reportParameters = null, CancellationToken cancellationToken = default)

Parameters

measurePoints MeasurePoint[]

Массив экземпляров класса MeasurePoint с параметрами точек учета, для которых формируется отчет.

startDate DateTime

Начальная дата периода.

endDate DateTime

Конечная дата периода.

reportOptions ReportOptions

Дополнительные параметры отчета задаваемые пользователем ReportOptions.

reportParameters ReportParameter[]

Массив пользовательских параметров ReportParameter, которые могут использоваться в скриптах отчетной формы.

cancellationToken CancellationToken

Токен отмены CancellationToken, который может использоваться для отмены асинхронной операции.

Returns

XtraReport

Экземпляр класса DevExpress.XtraReports.UI.XtraReport

GenerateConsumptionParametersReport(int[], DateTime, DateTime, ReportOptions, ReportParameter[], CancellationToken)

Формирует синхронно параметры потребления точек учета.

public XtraReport GenerateConsumptionParametersReport(int[] measurePointsId, DateTime startDate, DateTime endDate, ReportOptions reportOptions = null, ReportParameter[] reportParameters = null, CancellationToken cancellationToken = default)

Parameters

measurePointsId int[]

Массив идентификаторов точек учета, для которых формируется отчет.

startDate DateTime

Начальная дата периода.

endDate DateTime

Конечная дата периода.

reportOptions ReportOptions

Дополнительные параметры отчета задаваемые пользователем ReportOptions.

reportParameters ReportParameter[]

Массив пользовательских параметров ReportParameter, которые могут использоваться в скриптах отчетной формы.

cancellationToken CancellationToken

Токен отмены CancellationToken, который может использоваться для отмены асинхронной операции.

Returns

XtraReport

Экземпляр класса DevExpress.XtraReports.UI.XtraReport

GenerateConsumptionParametersReportAsync(int[], DateTime, DateTime, ReportOptions, ReportParameter[], CancellationToken)

Формирует параметры потребления точек учета асинхронно.

public Task<GeneratedReport> GenerateConsumptionParametersReportAsync(int[] idList, DateTime startDate, DateTime endDate, ReportOptions reportOptions = null, ReportParameter[] reportParameters = null, CancellationToken cancellationToken = default)

Parameters

idList int[]

Список идентификаторов точек учета.

startDate DateTime

Начальная дата периода.

endDate DateTime

Конечная дата периода.

reportOptions ReportOptions

Дополнительные параметры отчета задаваемые пользователем ReportOptions.

reportParameters ReportParameter[]

Массив пользовательских параметров ReportParameter, которые могут использоваться в скриптах отчетной формы.

cancellationToken CancellationToken

Токен отмены CancellationToken, который может использоваться для отмены асинхронной операции.

Returns

Task<GeneratedReport>

Экземпляр класса GeneratedReport

GenerateConsumptionParametersReportAsync(int[], int, DeviceDataType, DateTime, DateTime, ReportOptions, ReportParameter[], CancellationToken)

Формирует параметры потребления точек учета асинхронно.

public Task<GeneratedReport> GenerateConsumptionParametersReportAsync(int[] idList, int reportId, DeviceDataType deviceDataType, DateTime startDate, DateTime endDate, ReportOptions reportOptions = null, ReportParameter[] reportParameters = null, CancellationToken cancellationToken = default)

Parameters

idList int[]

Список идентификаторов точек учета.

reportId int

ID формируемого отчета.

deviceDataType DeviceDataType

Тип данных.

startDate DateTime

Начальная дата периода.

endDate DateTime

Конечная дата периода.

reportOptions ReportOptions

Дополнительные параметры отчета задаваемые пользователем ReportOptions.

reportParameters ReportParameter[]

Массив пользовательских параметров ReportParameter, которые могут использоваться в скриптах отчетной формы.

cancellationToken CancellationToken

Токен отмены CancellationToken, который может использоваться для отмены асинхронной операции.

Returns

Task<GeneratedReport>

Экземпляр класса GeneratedReport

GenerateConsumptionParametersReportRawAsync(int[], int, DateTime, DateTime, ReportOptions, ReportParameter[], CancellationToken)

Формирует параметры потребления точек учета асинхронно.

public Task<GeneratedReportRaw> GenerateConsumptionParametersReportRawAsync(int[] idList, int reportId, DateTime startDate, DateTime endDate, ReportOptions reportOptions = null, ReportParameter[] reportParameters = null, CancellationToken cancellationToken = default)

Parameters

idList int[]

Список идентификаторов точек учета.

reportId int

Идентификатор отчета.

startDate DateTime

Начальная дата периода.

endDate DateTime

Конечная дата периода.

reportOptions ReportOptions

Дополнительные параметры отчета задаваемые пользователем ReportOptions.

reportParameters ReportParameter[]

Массив пользовательских параметров ReportParameter, которые могут использоваться в скриптах отчетной формы.

cancellationToken CancellationToken

Токен отмены, который может использоваться для отмены асинхронной операции.

Returns

Task<GeneratedReportRaw>

Сформированный отчёт.

GenerateEquipmentSummaryReportAsync(int[], int, ReportOptions, ReportParameter[], CancellationToken)

Формирует сводный отчет по оборудованию для заданных объектов учета асинхронно.

public Task<GeneratedReport> GenerateEquipmentSummaryReportAsync(int[] nodeIdList, int reportId, ReportOptions reportOptions = null, ReportParameter[] reportParameters = null, CancellationToken cancellationToken = default)

Parameters

nodeIdList int[]

Список идентификаторов объектов учета.

reportId int

ID отчета.

reportOptions ReportOptions

Дополнительные параметры отчета задаваемые пользователем ReportOptions.

reportParameters ReportParameter[]

Массив пользовательских параметров ReportParameter, которые могут использоваться в скриптах отчетной формы.

cancellationToken CancellationToken

Токен отмены CancellationToken, который может использоваться для отмены асинхронной операции.

Returns

Task<GeneratedReport>

Экземпляр класса GeneratedReport

GenerateEquipmentSummaryReportRawAsync(int[], int, ReportOptions, ReportParameter[], CancellationToken)

Формирует сводный отчет по оборудованию для заданных объектов учета асинхронно.

public Task<GeneratedReportRaw> GenerateEquipmentSummaryReportRawAsync(int[] nodeIdList, int reportId, ReportOptions reportOptions = null, ReportParameter[] reportParameters = null, CancellationToken cancellationToken = default)

Parameters

nodeIdList int[]

Список идентификаторов объектов учета.

reportId int

ID отчета.

reportOptions ReportOptions

Дополнительные параметры отчета задаваемые пользователем ReportOptions.

reportParameters ReportParameter[]

Массив пользовательских параметров ReportParameter, которые могут использоваться в скриптах отчетной формы.

cancellationToken CancellationToken

Токен отмены, который может использоваться для отмены асинхронной операции.

Returns

Task<GeneratedReportRaw>

Сформированный отчёт.

GenerateExported(ReportExportOptions, int[], int[], ReportEntity, ReportType, int, DeviceDataType, DateTime, DateTime, ReportOptions, ReportParameter[], CancellationToken)

Формирует отчет (ведомость параметров) асинхронно.

public Task<ExportedReport> GenerateExported(ReportExportOptions exportOptions, int[] entityIdList, int[] nodeIdList, ReportEntity reportEntity, ReportType reportType, int reportId, DeviceDataType dataType, DateTime startDate, DateTime endDate, ReportOptions reportOptions = null, ReportParameter[] reportParameters = null, CancellationToken cancellationToken = default)

Parameters

exportOptions ReportExportOptions

Экземпляр класса с параметрами экспорта сформированных отчетов.

entityIdList int[]

Массив идентификаторов сущностей, для которых формируются отчеты.

nodeIdList int[]

Массив ID объектов учета для отчета с фиксированным набором объектов учета.

reportEntity ReportEntity

Тип сущности.

reportType ReportType

Тип отчета.

reportId int

Идентификатор отчета.

dataType DeviceDataType

Тип данных для отображения в отчетной форме.

startDate DateTime

Начальная дата периода.

endDate DateTime

Конечная дата периода.

reportOptions ReportOptions

Дополнительные параметры отчета задаваемые пользователем.

reportParameters ReportParameter[]

Массив пользовательских параметров, которые могут использоваться в скриптах отчетной формы.

cancellationToken CancellationToken

Токен отмены, который может использоваться для отмены асинхронной операции.

Returns

Task<ExportedReport>

GenerateFixedNodesReport(int, DeviceDataType, DateTime, DateTime, ReportOptions, ReportParameter[], CancellationToken)

Формирует синхронно "Отчет с фиксированным набором объектов".

public XtraReport GenerateFixedNodesReport(int reportId, DeviceDataType dataType, DateTime startDate, DateTime endDate, ReportOptions reportOptions = null, ReportParameter[] reportParameters = null, CancellationToken cancellationToken = default)

Parameters

reportId int

Идентификатор отчета.

dataType DeviceDataType

Тип данных для отображения в отчете.

startDate DateTime

Начальная дата периода.

endDate DateTime

Конечная дата периода.

reportOptions ReportOptions

Дополнительные параметры отчета задаваемые пользователем ReportOptions.

reportParameters ReportParameter[]

Массив пользовательских параметров ReportParameter, которые могут использоваться в скриптах отчетной формы.

cancellationToken CancellationToken

Токен отмены CancellationToken, который может использоваться для отмены асинхронной операции.

Returns

XtraReport

Экземпляр класса DevExpress.XtraReports.UI.XtraReport

GenerateFixedNodesReportAsync(int, DeviceDataType, DateTime, DateTime, ReportOptions, ReportParameter[], CancellationToken)

Формирует отчет "Отчет с фиксированным набором объектов" асинхронно

public Task<GeneratedReport> GenerateFixedNodesReportAsync(int reportId, DeviceDataType dataType, DateTime startDate, DateTime endDate, ReportOptions reportOptions = null, ReportParameter[] reportParameters = null, CancellationToken cancellationToken = default)

Parameters

reportId int

Идентификатор отчета.

dataType DeviceDataType

Тип данных для отображения в отчете.

startDate DateTime

Начальная дата периода.

endDate DateTime

Конечная дата периода.

reportOptions ReportOptions

Дополнительные параметры отчета задаваемые пользователем ReportOptions.

reportParameters ReportParameter[]

Массив пользовательских параметров ReportParameter, которые могут использоваться в скриптах отчетной формы.

cancellationToken CancellationToken

Токен отмены CancellationToken, который может использоваться для отмены асинхронной операции.

Returns

Task<GeneratedReport>

Экземпляр класса GeneratedReport

GenerateIncidentSummaryReport(int, DateTime, DateTime, ReportOptions, ReportParameter[], CancellationToken)

Формирует синхронно отчет о нештатных ситуациях.

public XtraReport GenerateIncidentSummaryReport(int reportId, DateTime startDate, DateTime endDate, ReportOptions reportOptions = null, ReportParameter[] reportParameters = null, CancellationToken cancellationToken = default)

Parameters

reportId int

Идентификатор отчета.

startDate DateTime

Начальная дата периода.

endDate DateTime

Конечная дата периода.

reportOptions ReportOptions

Дополнительные параметры отчета задаваемые пользователем ReportOptions.

reportParameters ReportParameter[]

Массив пользовательских параметров ReportParameter, которые могут использоваться в скриптах отчетной формы.

cancellationToken CancellationToken

Токен отмены CancellationToken, который может использоваться для отмены асинхронной операции.

Returns

XtraReport

Экземпляр класса DevExpress.XtraReports.UI.XtraReport

GenerateIncidentSummaryReportAsync(int, DateTime, DateTime, ReportOptions, ReportParameter[], int[], CancellationToken)

Формирует отчет о нештатных ситуациях асинхронно.

public Task<GeneratedReport> GenerateIncidentSummaryReportAsync(int reportId, DateTime startDate, DateTime endDate, ReportOptions reportOptions = null, ReportParameter[] reportParameters = null, int[] idList = null, CancellationToken cancellationToken = default)

Parameters

reportId int

Идентификатор отчета.

startDate DateTime

Начальная дата периода.

endDate DateTime

Конечная дата периода.

reportOptions ReportOptions

Дополнительные параметры отчета задаваемые пользователем.

reportParameters ReportParameter[]

Массив пользовательских параметров, которые могут использоваться в скриптах отчетной формы.

idList int[]

Список идентификаторов объектов учета.

cancellationToken CancellationToken

Токен отмены, который может использоваться для отмены асинхронной операции.

Returns

Task<GeneratedReport>

Экземпляр класса GeneratedReport

GenerateIncidentSummaryReportRawAsync(int, DateTime, DateTime, ReportOptions, ReportParameter[], int[], CancellationToken)

Формирует отчет о нештатных ситуациях асинхронно.

public Task<GeneratedReportRaw> GenerateIncidentSummaryReportRawAsync(int reportId, DateTime startDate, DateTime endDate, ReportOptions reportOptions = null, ReportParameter[] reportParameters = null, int[] idList = null, CancellationToken cancellationToken = default)

Parameters

reportId int

Идентификатор отчета.

startDate DateTime

Начальная дата периода.

endDate DateTime

Конечная дата периода.

reportOptions ReportOptions

Дополнительные параметры отчета задаваемые пользователем.

reportParameters ReportParameter[]

Массив пользовательских параметров, которые могут использоваться в скриптах отчетной формы.

idList int[]

Список идентификаторов объектов учета.

cancellationToken CancellationToken

Токен отмены, который может использоваться для отмены асинхронной операции.

Returns

Task<GeneratedReportRaw>

Сформированный отчёт.

GenerateNodeJobReport(int, DateTime, DateTime, ReportOptions, ReportParameter[], CancellationToken)

Формирует синхронно отчет о работах на объектах учета.

public XtraReport GenerateNodeJobReport(int reportId, DateTime startDate, DateTime endDate, ReportOptions reportOptions = null, ReportParameter[] reportParameters = null, CancellationToken cancellationToken = default)

Parameters

reportId int

Идентификатор отчета.

startDate DateTime

Начальная дата периода.

endDate DateTime

Конечная дата периода.

reportOptions ReportOptions

Дополнительные параметры отчета задаваемые пользователем ReportOptions.

reportParameters ReportParameter[]

Массив пользовательских параметров ReportParameter, которые могут использоваться в скриптах отчетной формы.

cancellationToken CancellationToken

Токен отмены CancellationToken, который может использоваться для отмены асинхронной операции.

Returns

XtraReport

Экземпляр класса DevExpress.XtraReports.UI.XtraReport

GenerateNodeJobReportAsync(int, DateTime, DateTime, ReportOptions, ReportParameter[], CancellationToken)

Формирует отчет о работах на объектах учета асинхронно.

public Task<GeneratedReport> GenerateNodeJobReportAsync(int reportId, DateTime startDate, DateTime endDate, ReportOptions reportOptions = null, ReportParameter[] reportParameters = null, CancellationToken cancellationToken = default)

Parameters

reportId int

Идентификатор отчета.

startDate DateTime

Начальная дата периода.

endDate DateTime

Конечная дата периода.

reportOptions ReportOptions

Дополнительные параметры отчета задаваемые пользователем ReportOptions.

reportParameters ReportParameter[]

Массив пользовательских параметров ReportParameter, которые могут использоваться в скриптах отчетной формы.

cancellationToken CancellationToken

Токен отмены CancellationToken, который может использоваться для отмены асинхронной операции.

Returns

Task<GeneratedReport>

Экземпляр класса GeneratedReport

GenerateNodeJobReportRawAsync(int, DateTime, DateTime, ReportOptions, ReportParameter[], CancellationToken)

Формирует отчет о работах на объектах учета асинхронно.

public Task<GeneratedReportRaw> GenerateNodeJobReportRawAsync(int reportId, DateTime startDate, DateTime endDate, ReportOptions reportOptions = null, ReportParameter[] reportParameters = null, CancellationToken cancellationToken = default)

Parameters

reportId int

Идентификатор отчета.

startDate DateTime

Начальная дата периода.

endDate DateTime

Конечная дата периода.

reportOptions ReportOptions

Дополнительные параметры отчета задаваемые пользователем ReportOptions.

reportParameters ReportParameter[]

Массив пользовательских параметров ReportParameter, которые могут использоваться в скриптах отчетной формы.

cancellationToken CancellationToken

Токен отмены, который может использоваться для отмены асинхронной операции.

Returns

Task<GeneratedReportRaw>

Сформированный отчёт.

GenerateNodeMeasurePointSummaryReport(Node, int, DateTime, DateTime, DeviceDataType, ReportOptions, ReportParameter[], CancellationToken)

Формирует синхронно сводный отчет по точкам учета объекта учета.

public XtraReport GenerateNodeMeasurePointSummaryReport(Node node, int reportId, DateTime startDate, DateTime endDate, DeviceDataType dataType, ReportOptions reportOptions = null, ReportParameter[] reportParameters = null, CancellationToken cancellationToken = default)

Parameters

node Node

Экземпляр объекта учета Node, для точек учета которого формируется сводный отчет.

reportId int

Идентификатор отчета.

startDate DateTime

Начальная дата периода.

endDate DateTime

Конечная дата периода.

dataType DeviceDataType

Тип данных DeviceDataType.

reportOptions ReportOptions

Дополнительные параметры отчета задаваемые пользователем ReportOptions.

reportParameters ReportParameter[]

Массив пользовательских параметров ReportParameter, которые могут использоваться в скриптах отчетной формы.

cancellationToken CancellationToken

Токен отмены CancellationToken, который может использоваться для отмены асинхронной операции.

Returns

XtraReport

Экземпляр класса DevExpress.XtraReports.UI.XtraReport

GenerateNodeMeasurePointSummaryReport(int, int, DateTime, DateTime, DeviceDataType, ReportOptions, ReportParameter[], CancellationToken)

Формирует сводный отчет по точкам учета объекта учета синхронно.

public XtraReport GenerateNodeMeasurePointSummaryReport(int nodeId, int reportId, DateTime startDate, DateTime endDate, DeviceDataType dataType, ReportOptions reportOptions = null, ReportParameter[] reportParameters = null, CancellationToken cancellationToken = default)

Parameters

nodeId int

Идентификатор объекта учета, для точек учета которого формируется сводный отчет.

reportId int

Идентификатор отчета.

startDate DateTime

Начальная дата периода.

endDate DateTime

Конечная дата периода.

dataType DeviceDataType

Тип данных DeviceDataType.

reportOptions ReportOptions

Дополнительные параметры отчета задаваемые пользователем ReportOptions.

reportParameters ReportParameter[]

Массив пользовательских параметров ReportParameter, которые могут использоваться в скриптах отчетной формы.

cancellationToken CancellationToken

Токен отмены CancellationToken, который может использоваться для отмены асинхронной операции.

Returns

XtraReport

Экземпляр класса DevExpress.XtraReports.UI.XtraReport

GenerateNodeMeasurePointSummaryReportAsync(int, int, DateTime, DateTime, DeviceDataType, ReportOptions, ReportParameter[], CancellationToken)

Формирует сводный отчет по точкам учета объекта учета асинхронно.

public Task<GeneratedReport> GenerateNodeMeasurePointSummaryReportAsync(int nodeId, int reportId, DateTime startDate, DateTime endDate, DeviceDataType dataType, ReportOptions reportOptions = null, ReportParameter[] reportParameters = null, CancellationToken cancellationToken = default)

Parameters

nodeId int

ID экземпляра объекта учета Node, для точек учета которого формируется сводный отчет.

reportId int

Идентификатор отчета.

startDate DateTime

Начальная дата периода.

endDate DateTime

Конечная дата периода.

dataType DeviceDataType

Тип данных DeviceDataType.

reportOptions ReportOptions

Дополнительные параметры отчета задаваемые пользователем ReportOptions.

reportParameters ReportParameter[]

Массив пользовательских параметров ReportParameter, которые могут использоваться в скриптах отчетной формы.

cancellationToken CancellationToken

Токен отмены CancellationToken, который может использоваться для отмены асинхронной операции.

Returns

Task<GeneratedReport>

Экземпляр класса GeneratedReport

GenerateNodePassportReportAsync(int, int, ReportOptions, ReportParameter[], CancellationToken)

Формирует паспорт объекта учета асинхронно.

public Task<GeneratedReport> GenerateNodePassportReportAsync(int nodeId, int reportId, ReportOptions reportOptions = null, ReportParameter[] reportParameters = null, CancellationToken cancellationToken = default)

Parameters

nodeId int

Идентификатор объекта учета.

reportId int

Идентификатор отчета.

reportOptions ReportOptions

Дополнительные параметры отчета задаваемые пользователем ReportOptions.

reportParameters ReportParameter[]

Массив пользовательских параметров ReportParameter, которые могут использоваться в скриптах отчетной формы.

cancellationToken CancellationToken

Токен отмены CancellationToken, который может использоваться для отмены асинхронной операции.

Returns

Task<GeneratedReport>

Экземпляр GeneratedReport.

GenerateNodePassportReportRawAsync(int, int, ReportOptions, ReportParameter[], CancellationToken)

Формирует паспорт объекта учета асинхронно.

public Task<GeneratedReportRaw> GenerateNodePassportReportRawAsync(int nodeId, int reportId, ReportOptions reportOptions = null, ReportParameter[] reportParameters = null, CancellationToken cancellationToken = default)

Parameters

nodeId int

Идентификатор объекта учета.

reportId int

Идентификатор отчета.

reportOptions ReportOptions

Дополнительные параметры отчета задаваемые пользователем ReportOptions.

reportParameters ReportParameter[]

Массив пользовательских параметров ReportParameter, которые могут использоваться в скриптах отчетной формы.

cancellationToken CancellationToken

Токен отмены, который может использоваться для отмены асинхронной операции.

Returns

Task<GeneratedReportRaw>

Сформированный отчёт.

GenerateNodeSectionAsync(int[], ReportEntity, int, DeviceDataType, DateTime, DateTime, ReportOptions, ReportParameter[], CancellationToken)

Формирует отчет (Секция объекта) асинхронно.

public Task<GeneratedReport> GenerateNodeSectionAsync(int[] entityArrayId, ReportEntity reportEntity, int reportId, DeviceDataType dataType, DateTime startDate, DateTime endDate, ReportOptions reportOptions = null, ReportParameter[] reportParameters = null, CancellationToken cancellationToken = default)

Parameters

entityArrayId int[]

Массив идентификаторов сущностей, для которых формируется отчет.

reportEntity ReportEntity

Тип объектов, которые используются в отчетной форме.

reportId int

Идентификатор отчета.

dataType DeviceDataType

Тип данных для отображения в отчетной форме.

startDate DateTime

Начальная дата периода.

endDate DateTime

Конечная дата периода.

reportOptions ReportOptions

Дополнительные параметры отчета задаваемые пользователем ReportOptions.

reportParameters ReportParameter[]

Массив пользовательских параметров ReportParameter, которые могут использоваться в скриптах отчетной формы.

cancellationToken CancellationToken

Токен отмены CancellationToken, который может использоваться для отмены асинхронной операции.

Returns

Task<GeneratedReport>

Экземпляр класса GeneratedReport.

GenerateParametersSheetAsync(int[], ReportEntity, int, DeviceDataType, DateTime, DateTime, ReportOptions, ReportParameter[], CancellationToken)

Формирует отчет (ведомость параметров) асинхронно.

public Task<GeneratedReport> GenerateParametersSheetAsync(int[] entityArrayId, ReportEntity reportEntity, int reportId, DeviceDataType dataType, DateTime startDate, DateTime endDate, ReportOptions reportOptions = null, ReportParameter[] reportParameters = null, CancellationToken cancellationToken = default)

Parameters

entityArrayId int[]

Массив идентификаторов сущностей, для которых формируется отчет.

reportEntity ReportEntity

Тип объектов, которые используются в отчетной форме.

reportId int

Идентификатор отчета.

dataType DeviceDataType

Тип данных для отображения в отчетной форме.

startDate DateTime

Начальная дата периода.

endDate DateTime

Конечная дата периода.

reportOptions ReportOptions

Дополнительные параметры отчета задаваемые пользователем ReportOptions.

reportParameters ReportParameter[]

Массив пользовательских параметров ReportParameter, которые могут использоваться в скриптах отчетной формы.

cancellationToken CancellationToken

Токен отмены CancellationToken, который может использоваться для отмены асинхронной операции.

Returns

Task<GeneratedReport>

Экземпляр класса GeneratedReport.

GeneratePreparedReport(int)

Формирует синхронно сохраненный отчет.

public XtraReport GeneratePreparedReport(int preparedReportId)

Parameters

preparedReportId int

ID сформированного и сохраненного отчета.

Returns

XtraReport

GenerateRegisterAsync(int[], BaseGenerateReportRequestParameters, ReportParameter[], CancellationToken)

Формирует реестр отчетов типа 'Ведомость параметров' для точек учета асинхронно.

public Task<GeneratedReport> GenerateRegisterAsync(int[] measurePointIdArray, BaseGenerateReportRequestParameters requestParameters = null, ReportParameter[] reportParameters = null, CancellationToken cancellationToken = default)

Parameters

measurePointIdArray int[]

Массив ID точек учета, по которым формируется реестр

requestParameters BaseGenerateReportRequestParameters

Параметры для формирования отчета.

reportParameters ReportParameter[]

Массив пользовательских параметров, которые могут использоваться в скриптах отчетной формы.

cancellationToken CancellationToken

Токен отмены, который может использоваться для отмены асинхронной операции.

Returns

Task<GeneratedReport>

Экземпляр класса GeneratedReport.

GenerateRegisterAsync(int[], ReportOptions, ReportParameter[], CancellationToken)

Формирует реестр отчетов типа 'Ведомость параметров' для точек учета асинхронно.

public Task<GeneratedReport> GenerateRegisterAsync(int[] measurePointIdArray, ReportOptions reportOptions = null, ReportParameter[] reportParameters = null, CancellationToken cancellationToken = default)

Parameters

measurePointIdArray int[]

Массив ID точек учета, по которым формируется реестр

reportOptions ReportOptions

Дополнительные параметры отчета задаваемые пользователем ReportOptions могут содержать ID отчетной формы реестра. Если ID отчетной формы реестра не задана, то используется системная отчетная форма реестра.

reportParameters ReportParameter[]

Массив пользовательских параметров ReportParameter, которые могут использоваться в скриптах отчетной формы.

cancellationToken CancellationToken

Токен отмены CancellationToken, который может использоваться для отмены асинхронной операции.

Returns

Task<GeneratedReport>

Экземпляр класса GeneratedReport.

GenerateRegisterRawAsync(int[], BaseGenerateReportRequestParameters, ReportParameter[], CancellationToken)

Формирует реестр отчетов типа 'Ведомость параметров' для точек учета асинхронно.

public Task<GeneratedReportRaw> GenerateRegisterRawAsync(int[] measurePointIdArray, BaseGenerateReportRequestParameters requestParameters = null, ReportParameter[] reportParameters = null, CancellationToken cancellationToken = default)

Parameters

measurePointIdArray int[]

Массив ID точек учета, по которым формируется реестр

requestParameters BaseGenerateReportRequestParameters

Параметры для формирования отчета.

reportParameters ReportParameter[]

Массив пользовательских параметров, которые могут использоваться в скриптах отчетной формы.

cancellationToken CancellationToken

Токен отмены, который может использоваться для отмены асинхронной операции.

Returns

Task<GeneratedReportRaw>

Экземпляр класса GeneratedReport.

GenerateRegisterRawAsync(int[], ReportOptions, ReportParameter[], CancellationToken)

Формирует реестр отчетов типа 'Ведомость параметров' для точек учета асинхронно.

public Task<GeneratedReportRaw> GenerateRegisterRawAsync(int[] measurePointIdArray, ReportOptions reportOptions = null, ReportParameter[] reportParameters = null, CancellationToken cancellationToken = default)

Parameters

measurePointIdArray int[]

Массив ID точек учета, по которым формируется реестр

reportOptions ReportOptions

Дополнительные параметры отчета задаваемые пользователем ReportOptions могут содержать ID отчетной формы реестра. Если ID отчетной формы реестра не задана, то используется системная отчетная форма реестра.

reportParameters ReportParameter[]

Массив пользовательских параметров ReportParameter, которые могут использоваться в скриптах отчетной формы.

cancellationToken CancellationToken

Токен отмены CancellationToken, который может использоваться для отмены асинхронной операции.

Returns

Task<GeneratedReportRaw>

Экземпляр класса GeneratedReportRaw.

GenerateReport(int, ReportEntity, int, DeviceDataType, DateTime, DateTime, ReportOptions, ReportParameter[], CancellationToken)

Формирует синхронно отчет "Ведомость параметров".

public XtraReport GenerateReport(int entityId, ReportEntity reportEntity, int reportId, DeviceDataType dataType, DateTime startDate, DateTime endDate, ReportOptions reportOptions = null, ReportParameter[] reportParameters = null, CancellationToken cancellationToken = default)

Parameters

entityId int

ID сущности , для которой формируется отчет.

reportEntity ReportEntity

Тип сущности ReportEntity, для которой формируется отчет.

reportId int

Идентификатор отчета.

dataType DeviceDataType

Тип данных для отображения в отчете.

startDate DateTime

Начальная дата периода.

endDate DateTime

Конечная дата периода.

reportOptions ReportOptions

Дополнительные параметры отчета задаваемые пользователем ReportOptions.

reportParameters ReportParameter[]

Массив пользовательских параметров ReportParameter, которые могут использоваться в скриптах отчетной формы.

cancellationToken CancellationToken

Токен отмены CancellationToken, который может использоваться для отмены асинхронной операции.

Returns

XtraReport

Экземпляр класса DevExpress.XtraReports.UI.XtraReport

GenerateSummaryIntervalReportAsync(int[], int, DateTime, DateTime, DeviceDataType, ReportOptions, ReportParameter[], CancellationToken)

Формирует сводный интервальный отчет по точкам учета асинхронно.

public Task<GeneratedReport> GenerateSummaryIntervalReportAsync(int[] idList, int reportId, DateTime startDate, DateTime endDate, DeviceDataType dataType, ReportOptions reportOptions = null, ReportParameter[] reportParameters = null, CancellationToken cancellationToken = default)

Parameters

idList int[]

Массив идентификаторов сущностей.

reportId int

Идентификатор отчета.

startDate DateTime

Начальная дата периода.

endDate DateTime

Конечная дата периода.

dataType DeviceDataType

Тип данных DeviceDataType.

reportOptions ReportOptions

Дополнительные параметры отчета задаваемые пользователем ReportOptions.

reportParameters ReportParameter[]

Массив пользовательских параметров ReportParameter, которые могут использоваться в скриптах отчетной формы.

cancellationToken CancellationToken

Токен отмены CancellationToken, который может использоваться для отмены асинхронной операции.

Returns

Task<GeneratedReport>

Экземпляр класса GeneratedReport

GenerateSummaryIntervalReportRawAsync(int[], int, DateTime, DateTime, DeviceDataType, ReportOptions, ReportParameter[], CancellationToken)

Формирует сводный интервальный отчет по точкам учета асинхронно.

public Task<GeneratedReportRaw> GenerateSummaryIntervalReportRawAsync(int[] idList, int reportId, DateTime startDate, DateTime endDate, DeviceDataType dataType, ReportOptions reportOptions = null, ReportParameter[] reportParameters = null, CancellationToken cancellationToken = default)

Parameters

idList int[]

Массив идентификаторов сущностей.

reportId int

Идентификатор отчета.

startDate DateTime

Начальная дата периода.

endDate DateTime

Конечная дата периода.

dataType DeviceDataType

Тип данных DeviceDataType.

reportOptions ReportOptions

Дополнительные параметры отчета задаваемые пользователем ReportOptions.

reportParameters ReportParameter[]

Массив пользовательских параметров ReportParameter, которые могут использоваться в скриптах отчетной формы.

cancellationToken CancellationToken

Токен отмены, который может использоваться для отмены асинхронной операции.

Returns

Task<GeneratedReportRaw>

Сформированный отчёт.

GenerateSummaryReport(Node[], int, DateTime, DateTime, DeviceDataType, ReportOptions, ReportParameter[], CancellationToken)

Формирует синхронно сводный отчет по объектам учета.

public XtraReport GenerateSummaryReport(Node[] nodes, int reportId, DateTime startDate, DateTime endDate, DeviceDataType dataType, ReportOptions reportOptions = null, ReportParameter[] reportParameters = null, CancellationToken cancellationToken = default)

Parameters

nodes Node[]

Массив объектов учета Node, для которых формируется сводный отчет.

reportId int

Идентификатор отчета.

startDate DateTime

Начальная дата периода.

endDate DateTime

Конечная дата периода.

dataType DeviceDataType

Тип данных DeviceDataType.

reportOptions ReportOptions

Дополнительные параметры отчета задаваемые пользователем ReportOptions.

reportParameters ReportParameter[]

Массив пользовательских параметров ReportParameter, которые могут использоваться в скриптах отчетной формы.

cancellationToken CancellationToken

Токен отмены CancellationToken, который может использоваться для отмены асинхронной операции.

Returns

XtraReport

Экземпляр класса DevExpress.XtraReports.UI.XtraReport

GenerateSummaryReport(int[], int, ReportEntity, DateTime, DateTime, DeviceDataType, ReportOptions, ReportParameter[], CancellationToken)

Формирует синхронно сводный отчет.

public XtraReport GenerateSummaryReport(int[] idList, int reportId, ReportEntity reportEntity, DateTime startDate, DateTime endDate, DeviceDataType dataType, ReportOptions reportOptions = null, ReportParameter[] reportParameters = null, CancellationToken cancellationToken = default)

Parameters

idList int[]

Массив идентификаторов сущностей.

reportId int

Идентификатор отчета.

reportEntity ReportEntity

Тип сущностей, которые используются в отчетной форме.

startDate DateTime

Начальная дата периода.

endDate DateTime

Конечная дата периода.

dataType DeviceDataType

Тип данных DeviceDataType.

reportOptions ReportOptions

Дополнительные параметры отчета задаваемые пользователем ReportOptions.

reportParameters ReportParameter[]

Массив пользовательских параметров ReportParameter, которые могут использоваться в скриптах отчетной формы.

cancellationToken CancellationToken

Токен отмены CancellationToken, который может использоваться для отмены асинхронной операции.

Returns

XtraReport

Экземпляр класса DevExpress.XtraReports.UI.XtraReport

GenerateSummaryReportAsync(int[], int, ReportEntity, DateTime, DateTime, DeviceDataType, ReportOptions, ReportParameter[], CancellationToken)

Формирует сводный отчет асинхронно.

public Task<GeneratedReport> GenerateSummaryReportAsync(int[] idList, int reportId, ReportEntity reportEntity, DateTime startDate, DateTime endDate, DeviceDataType dataType, ReportOptions reportOptions = null, ReportParameter[] reportParameters = null, CancellationToken cancellationToken = default)

Parameters

idList int[]

Список идентификаторов сущностей.

reportId int

Идентификатор отчета.

reportEntity ReportEntity

Тип объектов, которые используются в отчетной форме.

startDate DateTime

Начальная дата периода.

endDate DateTime

Конечная дата периода.

dataType DeviceDataType

Тип данных DeviceDataType.

reportOptions ReportOptions

Дополнительные параметры отчета задаваемые пользователем ReportOptions.

reportParameters ReportParameter[]

Массив пользовательских параметров ReportParameter, которые могут использоваться в скриптах отчетной формы.

cancellationToken CancellationToken

Токен отмены CancellationToken, который может использоваться для отмены асинхронной операции.

Returns

Task<GeneratedReport>

Экземпляр класса GeneratedReport

GenerateSummaryReportRawAsync(int[], int, ReportEntity, DateTime, DateTime, DeviceDataType, ReportOptions, ReportParameter[], CancellationToken)

Формирует сводный отчет асинхронно.

public Task<GeneratedReportRaw> GenerateSummaryReportRawAsync(int[] idList, int reportId, ReportEntity reportEntity, DateTime startDate, DateTime endDate, DeviceDataType dataType, ReportOptions reportOptions = null, ReportParameter[] reportParameters = null, CancellationToken cancellationToken = default)

Parameters

idList int[]

Список идентификаторов сущностей.

reportId int

Идентификатор отчета.

reportEntity ReportEntity

Тип объектов, которые используются в отчетной форме.

startDate DateTime

Начальная дата периода.

endDate DateTime

Конечная дата периода.

dataType DeviceDataType

Тип данных DeviceDataType.

reportOptions ReportOptions

Дополнительные параметры отчета задаваемые пользователем ReportOptions.

reportParameters ReportParameter[]

Массив пользовательских параметров ReportParameter, которые могут использоваться в скриптах отчетной формы.

cancellationToken CancellationToken

Токен отмены, который может использоваться для отмены асинхронной операции.

Returns

Task<GeneratedReportRaw>

Сформированный отчёт.

GenerateSystemStateReport(int, ReportOptions, ReportParameter[], CancellationToken)

Формирует синхронно отчет о состоянии системы.

public XtraReport GenerateSystemStateReport(int reportId, ReportOptions reportOptions = null, ReportParameter[] reportParameters = null, CancellationToken cancellationToken = default)

Parameters

reportId int

Идентификатор отчета.

reportOptions ReportOptions

Дополнительные параметры отчета задаваемые пользователем ReportOptions.

reportParameters ReportParameter[]

Массив пользовательских параметров ReportParameter, которые могут использоваться в скриптах отчетной формы.

cancellationToken CancellationToken

Токен отмены CancellationToken, который может использоваться для отмены асинхронной операции.

Returns

XtraReport

Экземпляр класса DevExpress.XtraReports.UI.XtraReport

GenerateSystemStateReportAsync(int, ReportOptions, ReportParameter[], CancellationToken)

Формирует отчет о состоянии системы асинхронно.

public Task<GeneratedReport> GenerateSystemStateReportAsync(int reportId, ReportOptions reportOptions = null, ReportParameter[] reportParameters = null, CancellationToken cancellationToken = default)

Parameters

reportId int

ID отчета.

reportOptions ReportOptions

Дополнительные параметры отчета задаваемые пользователем ReportOptions.

reportParameters ReportParameter[]

Массив пользовательских параметров ReportParameter, которые могут использоваться в скриптах отчетной формы.

cancellationToken CancellationToken

Токен отмены CancellationToken, который может использоваться для отмены асинхронной операции.

Returns

Task<GeneratedReport>

Экземпляр класса GeneratedReport

GenerateSystemStateReportRawAsync(int, ReportOptions, ReportParameter[], CancellationToken)

Формирует отчет о состоянии системы асинхронно.

public Task<GeneratedReportRaw> GenerateSystemStateReportRawAsync(int reportId, ReportOptions reportOptions = null, ReportParameter[] reportParameters = null, CancellationToken cancellationToken = default)

Parameters

reportId int

ID отчета.

reportOptions ReportOptions

Дополнительные параметры отчета задаваемые пользователем ReportOptions.

reportParameters ReportParameter[]

Массив пользовательских параметров ReportParameter, которые могут использоваться в скриптах отчетной формы.

cancellationToken CancellationToken

Токен отмены, который может использоваться для отмены асинхронной операции.

Returns

Task<GeneratedReportRaw>

Сформированный отчёт.

GenerateWorkOrderReport(int, int, DateTime, DateTime, ReportOptions, ReportParameter[], CancellationToken)

Формирует синхронно отчет по нарядам на работы.

public XtraReport GenerateWorkOrderReport(int nodeJobId, int reportId, DateTime startDate, DateTime endDate, ReportOptions reportOptions = null, ReportParameter[] reportParameters = null, CancellationToken cancellationToken = default)

Parameters

nodeJobId int

Идентификатор работы, для которой надо сформировать наряд.

reportId int

Идентификатор отчета.

startDate DateTime

Начальная дата периода.

endDate DateTime

Конечная дата периода.

reportOptions ReportOptions

Дополнительные параметры отчета задаваемые пользователем ReportOptions.

reportParameters ReportParameter[]

Массив пользовательских параметров ReportParameter, которые могут использоваться в скриптах отчетной формы.

cancellationToken CancellationToken

Токен отмены CancellationToken, который может использоваться для отмены асинхронной операции.

Returns

XtraReport

Экземпляр класса DevExpress.XtraReports.UI.XtraReport

GenerateWorkOrderReportAsync(int[], int, DateTime, DateTime, ReportOptions, ReportParameter[], CancellationToken)

Формирует отчет по нарядам на работы асинхронно.

public Task<GeneratedReport> GenerateWorkOrderReportAsync(int[] nodeJobIdList, int reportId, DateTime startDate, DateTime endDate, ReportOptions reportOptions = null, ReportParameter[] reportParameters = null, CancellationToken cancellationToken = default)

Parameters

nodeJobIdList int[]

Идентификаторы работ, для которых надо сформировать наряд.

reportId int

Идентификатор отчета.

startDate DateTime

Начальная дата периода.

endDate DateTime

Конечная дата периода.

reportOptions ReportOptions

Дополнительные параметры отчета задаваемые пользователем ReportOptions.

reportParameters ReportParameter[]

Массив пользовательских параметров ReportParameter, которые могут использоваться в скриптах отчетной формы.

cancellationToken CancellationToken

Токен отмены CancellationToken, который может использоваться для отмены асинхронной операции.

Returns

Task<GeneratedReport>

Экземпляр класса GeneratedReport

GenerateWorkOrderReportRawAsync(int[], int, DateTime, DateTime, ReportOptions, ReportParameter[], CancellationToken)

Формирует отчет по нарядам на работы асинхронно.

public Task<GeneratedReportRaw> GenerateWorkOrderReportRawAsync(int[] nodeJobIdList, int reportId, DateTime startDate, DateTime endDate, ReportOptions reportOptions = null, ReportParameter[] reportParameters = null, CancellationToken cancellationToken = default)

Parameters

nodeJobIdList int[]

Идентификаторы работ, для которых надо сформировать наряд.

reportId int

Идентификатор отчета.

startDate DateTime

Начальная дата периода.

endDate DateTime

Конечная дата периода.

reportOptions ReportOptions

Дополнительные параметры отчета задаваемые пользователем ReportOptions.

reportParameters ReportParameter[]

Массив пользовательских параметров ReportParameter, которые могут использоваться в скриптах отчетной формы.

cancellationToken CancellationToken

Токен отмены, который может использоваться для отмены асинхронной операции.

Returns

Task<GeneratedReportRaw>

Сформированный отчёт.

GetAssignableReportTemplatesAsync(ReportType, ReportEntity, MeasurePointType)

Возвращает список отчётных форм которые могут быть назначены сущности.

public Task<ReportTemplate[]> GetAssignableReportTemplatesAsync(ReportType reportType, ReportEntity reportEntity, MeasurePointType measurePointType)

Parameters

reportType ReportType

Тип отчёта.

reportEntity ReportEntity

Тип сущности.

measurePointType MeasurePointType

Тип точек учёта.

Returns

Task<ReportTemplate[]>

GetAssignableReportsAsync(ReportType, ReportEntity, MeasurePointType)

Возвращает список отчётов, которые могут быть назначены сущности.

public Task<Report[]> GetAssignableReportsAsync(ReportType reportType, ReportEntity reportEntity, MeasurePointType measurePointType)

Parameters

reportType ReportType

Тип отчёта.

reportEntity ReportEntity

Тип сущности.

measurePointType MeasurePointType

Тип точек учёта.

Returns

Task<Report[]>

GetDataSourceAsync(ReportType, ReportEntity)

Получает асинхронно структуру источника данных.

public Task<DataSet> GetDataSourceAsync(ReportType reportType, ReportEntity reportEntity)

Parameters

reportType ReportType

reportEntity ReportEntity

Returns

Task<DataSet>

GetGeneratedReportRawAsync(int[], ReportEntity, ReportType, int, DeviceDataType, DateTime, DateTime, ReportOptions, ReportParameter[], CancellationToken)

Формирует асинхронно FastReport-отчет заданного тип для заданной сущности.

public Task<GeneratedReportRaw> GetGeneratedReportRawAsync(int[] entityArrayId, ReportEntity reportEntity, ReportType reportType, int reportId, DeviceDataType dataType, DateTime startDate, DateTime endDate, ReportOptions reportOptions = null, ReportParameter[] reportParameters = null, CancellationToken cancellationToken = default)

Parameters

entityArrayId int[]

Массив идентификаторов сущностей, для которых формируется отчет.

reportEntity ReportEntity

Тип сущности, для которой формируется отчет.

reportType ReportType

Тип отчета, для которого формируется отчет.

reportId int

Идентификатор отчета.

dataType DeviceDataType

Тип данных для отображения в отчете.

startDate DateTime

Начальная дата периода.

endDate DateTime

Конечная дата периода.

reportOptions ReportOptions

Дополнительные параметры отчета задаваемые пользователем ReportOptions.

reportParameters ReportParameter[]

Массив пользовательских параметров ReportParameter, которые могут использоваться в скриптах отчетной формы.

cancellationToken CancellationToken

Токен отмены CancellationToken, который может использоваться для отмены асинхронной операции.

Returns

Task<GeneratedReportRaw>

Экземпляр класса GeneratedReportRaw

GetPreparedReportAsync(int)

Возвращает сохраненный отчет асинхронно.

public Task<GeneratedReport> GetPreparedReportAsync(int preparedReportId)

Parameters

preparedReportId int

Id сохраненного отчета.

Returns

Task<GeneratedReport>

Экземпляр класса DevExpress.XtraReports.UI.XtraReport

GetPreviewGeneratedReportRawAsync(int[], PreviewReportRequestParameters, CancellationToken)

Асинхронная операция формирования FastReport-отчета из редактора отчетов.

public Task<GeneratedReportRaw> GetPreviewGeneratedReportRawAsync(int[] entityIdList, PreviewReportRequestParameters requestParameters, CancellationToken cancellationToken = default)

Parameters

entityIdList int[]

Массив ID сущностей, для которых формируется отчет.

requestParameters PreviewReportRequestParameters

Массив пользовательских параметров ReportParameter, которые могут использоваться в скриптах отчетной формы.

cancellationToken CancellationToken

Токен отмены CancellationToken, который может использоваться для отмены асинхронной операции.

Returns

Task<GeneratedReportRaw>

GetPreviewReportInternal(int[], PreviewReportRequestParameters, CancellationToken)

Начинает асинхронную операцию получения данных для формирования отчета из редактора отчетов.

public Task<GeneratedReport> GetPreviewReportInternal(int[] entityIdList, PreviewReportRequestParameters requestParameters, CancellationToken cancellationToken = default)

Parameters

entityIdList int[]

Массив ID сущностей, для которых формируется отчет.

requestParameters PreviewReportRequestParameters

Массив пользовательских параметров ReportParameter, которые могут использоваться в скриптах отчетной формы.

cancellationToken CancellationToken

Токен отмены CancellationToken, который может использоваться для отмены асинхронной операции.

Returns

Task<GeneratedReport>

GetReportListAsync()

Получает список всех отчетов асинхронно.

public Task<Report[]> GetReportListAsync()

Returns

Task<Report[]>

Список отчетных форм.

GetReportListAsync(ReportType, ReportEntity)

Получает асинхронно список отчетов заданного типа и сущности.

public Task<Report[]> GetReportListAsync(ReportType reportType, ReportEntity reportEntity)

Parameters

reportType ReportType

Тип отчета ReportType. Если ReportType.None, то для всех типов.

reportEntity ReportEntity

Тип сущности ReportEntity. Если ReportEntity.None, то для всех сущностей.

Returns

Task<Report[]>

Список отчетных форм.

GetReportListAsync(ReportType, ReportEntity, IEnumerable<int>)

Получает асинхронно список отчетов заданного типа и сущности.

public Task<Report[]> GetReportListAsync(ReportType reportType, ReportEntity reportEntity, IEnumerable<int> entityIds)

Parameters

reportType ReportType

Тип отчета ReportType. Если ReportType.None, то для всех типов.

reportEntity ReportEntity

Тип сущности ReportEntity. Если ReportEntity.None, то для всех сущностей.

entityIds IEnumerable<int>

Список идентификаторов сущностей, для которых нужно запросить список отчётов.

Returns

Task<Report[]>

Список отчетных форм.

Remarks

Вернутся только те отчеты, которые используются хотя бы в одной сущности из заданного массива entityIds. Если массив равен null, будет возвращён полный список отчётов, которые возможны для указанного типа сущностей.

GetReportTemplateByIdAsync(int)

Получает асинхронно отчетную форму по заданному ID.

public Task<ReportTemplate> GetReportTemplateByIdAsync(int reportTemplateId)

Parameters

reportTemplateId int

ID требуемой отчетной формы.

Returns

Task<ReportTemplate>

Отчетная форма ReportTemplate.

GetReportTemplateListAsync()

Получает список всех отчетных форм асинхронно.

public Task<ReportTemplate[]> GetReportTemplateListAsync()

Returns

Task<ReportTemplate[]>

Список отчетных форм.

GetReportTemplateListAsync(ReportType, ReportEntity)

Получает асинхронно список отчетных форм заданного типа и сущности.

public Task<ReportTemplate[]> GetReportTemplateListAsync(ReportType reportType, ReportEntity reportEntity)

Parameters

reportType ReportType

Тип отчетной формы ReportType. Если ReportType.None, то для всех типов.

reportEntity ReportEntity

Тип сущности ReportEntity. Если ReportEntity.None, то для всех сущностей.

Returns

Task<ReportTemplate[]>

Список отчетных форм.

GetReportTemplateWithDataSourceAsync(ReportTemplate)

Получает асинхронно отчетную форму cо структурой источника данных.

public Task<ReportTemplate> GetReportTemplateWithDataSourceAsync(ReportTemplate reportTemplate)

Parameters

reportTemplate ReportTemplate

ID требуемой отчетной формы.

Returns

Task<ReportTemplate>

GetReportTemplateWithDataSourceAsync(ReportTemplate)

Получает асинхронно отчетную форму cо структурой источника данных.

public Task<ReportTemplate> GetReportTemplateWithDataSourceAsync(ReportTemplate reportTemplate)

Parameters

reportTemplate ReportTemplate

Шаблон отчетной формы, для которой нужно получить структуру источника данных.

Returns

Task<ReportTemplate>

NewReport(string, ReportEntity)

Создает новый отчет.

public Report NewReport(string title, ReportEntity entity)

Parameters

title string

Наименование отчета.

entity ReportEntity

Тип сущности для которой будет использован отчет.

Returns

Report

Экземпляр Report.

SetAutoFitToPagesWidth(bool, int, float)

Задает подгонки отчета под ширину страницы. true - подгонка под ширину страницы, false - без подгонки под ширину страницы.

public void SetAutoFitToPagesWidth(bool autoFit, int autoFitToPagesWidth, float scaleFactor)

Parameters

autoFit bool

autoFitToPagesWidth int

scaleFactor float

SetCreateRegistry(bool, int[])

Задает признак создания реестра сформированных отчетов.

public void SetCreateRegistry(bool createRegistry, int[] measurePointArrayId)

Parameters

createRegistry bool

measurePointArrayId int[]

Events

ReportTemplateChanged

Вызывается когда от сервера приходит событие об изменении отчёта.

public event EventHandler<ReportChangedEventArgs> ReportTemplateChanged

Event Type

EventHandler<ReportChangedEventArgs>