Class ReportTemplate

Namespace

Geotab.Checkmate.ObjectModel

Assembly

Geotab.Checkmate.ObjectModel.dll

ReportTemplate class represents a template for reports that is an Excel file.

public class ReportTemplate : NameEntity, IEntity, IComparable, IIdentifiable, IDefaultable

Inheritance

object

Entity

NameEntity

ReportTemplate

Implements

IEntity

IComparable

IIdentifiable

IDefaultable

Inherited Members

NameEntity.CompareTo(object)

NameEntity.ToString()

NameEntity.Name

Entity.GetReadOnly()

Entity.Equals(object)

Entity.GetHashCode()

Entity.IsSystemEntity()

Entity.Id

object.GetType()

object.MemberwiseClone()

object.Equals(object, object)

object.ReferenceEquals(object, object)

Constructors

ReportTemplate()

Initializes a new instance of the ReportTemplate class.Default constructor.

public ReportTemplate()

ReportTemplate(Id?, string?, ReportDataSource?, byte[]?, ReportTemplateType?, bool?, ReportExtensionType?)

Initializes a new instance of the ReportTemplate class.Initializes a new instance of the ReportTemplate class.

public ReportTemplate(Id? id, string? name, ReportDataSource? reportDataSource, byte[]? binaryData, ReportTemplateType? reportTemplateType, bool? showReport, ReportExtensionType? reportExtensionType)

Parameters

id Id

The Id.

name string

The report template name.

reportDataSource ReportDataSource?

The ReportDataSource that specify for what the ReportTemplate is for.

binaryData byte[]

The binary data for Excel file.

reportTemplateType ReportTemplateType?

The report template type.

showReport bool?

If set to true, show the report in the report dropdowns.

reportExtensionType ReportExtensionType?

Report extension type

ReportTemplate(Id?, string?, ReportDataSource?, byte[]?, bool?, ReportTemplateType?, bool?, ReportExtensionType?)

Initializes a new instance of the ReportTemplate class.Initializes a new instance of the ReportTemplate class.

public ReportTemplate(Id? id, string? name, ReportDataSource? reportDataSource, byte[]? binaryData, bool? isSystem, ReportTemplateType? reportTemplateType, bool? showReport, ReportExtensionType? reportExtensionType)

Parameters

id Id

The Id.

name string

The name.

reportDataSource ReportDataSource?

The report data source.

binaryData byte[]

The binary data.

isSystem bool?

If set to true [is system].

reportTemplateType ReportTemplateType?

The report template type.

showReport bool?

If set to true, show the report in the report dropdowns.

reportExtensionType ReportExtensionType?

Report Extension type

Properties

BinaryData

Gets or sets the Excel binary data.

public byte[]? BinaryData { get; set; }

Property Value

byte[]

byte buffer.

IsSystem

Gets or sets whether the ReportTemplate is System.

public bool? IsSystem { get; set; }

Property Value

bool?

bool

ReportDataSource

Gets or sets the ReportDataSource.

public ReportDataSource? ReportDataSource { get; set; }

Property Value

ReportDataSource?

ReportDataSource

ReportExtensionType

Gets or sets the ReportExtensionType.

public ReportExtensionType? ReportExtensionType { get; set; }

Property Value

ReportExtensionType?

ReportExtensionType

ReportTemplateType

Gets or sets the ReportTemplateType.

public ReportTemplateType? ReportTemplateType { get; set; }

Property Value

ReportTemplateType?

ReportTemplateType

ShowReport

Gets or sets whether the ReportTemplate is shown in the report dropdowns.

public bool? ShowReport { get; set; }

Property Value

bool?

bool

Methods

AssignBinaryData(byte[]?)

Assign the Excel binary data to the ReportTemplate.

public void AssignBinaryData(byte[]? data)

Parameters

data byte[]

The binary data.

ClearBinaryData()

Clear binary data for the ReportTemplate.

public void ClearBinaryData()

Clone()

Creates a new object that is a copy of the current instance.

public override IEntity Clone()

Returns

IEntity

A new object that is a copy of this instance.

PopulateDefaults()

Populate non-required empty (null) properties with default values.

public void PopulateDefaults()