Show / Hide Table of Contents

Class ReportTemplateBase

Provides base functionality for an IReportTemplate.

Inheritance
System.Object
ReportTemplateBase
ReportTemplate
Implements
IReportTemplate
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Sartorius.SAF.ReportGenerator
Assembly: Sartorius.SAF.ReportGenerator.dll
Syntax
public abstract class ReportTemplateBase : IReportTemplate

Constructors

View Source

ReportTemplateBase()

Initializes a new instance of the ReportTemplateBase with the default source mime type for XSL templates.

Declaration
protected ReportTemplateBase()
View Source

ReportTemplateBase(String)

Initializes a new instance of the ReportTemplateBase with the specified source mime type.

Declaration
protected ReportTemplateBase(string sourceMimeType)
Parameters
Type Name Description
System.String sourceMimeType

The mime type of the source material the template provides.

Properties

View Source

Description

Gets the localized report description.

Declaration
public virtual string Description { get; }
Property Value
Type Description
System.String
View Source

Id

Gets the report id.

Declaration
public virtual Guid Id { get; }
Property Value
Type Description
System.Guid
View Source

Name

Gets the localized report name.

Declaration
public virtual string Name { get; }
Property Value
Type Description
System.String
View Source

ReportCultures

Gets the list of actual report languages / cultures.

Declaration
public virtual IEnumerable<CultureInfo> ReportCultures { get; }
Property Value
Type Description
System.Collections.Generic.IEnumerable<System.Globalization.CultureInfo>
View Source

ResourceLocator

Gets the IResourceLocator.

Declaration
[Import]
protected IResourceLocator ResourceLocator { get; }
Property Value
Type Description
IResourceLocator

Methods

View Source

CreateReportInstance()

Creates an instance of the report defined by the IReportTemplate.

Declaration
public IReportInstance<IReportTemplate> CreateReportInstance()
Returns
Type Description
IReportInstance<IReportTemplate>

An instance of the report that can be used to collect data and create a report document.

View Source

CreateReportInstanceOverride()

Creates a Sartorius.SAF.ReportGenerator.ReportTemplateBase.ReportInstance`2 or a more specific IReportInstance<TTemplate> when overridden by derived classes.

Declaration
protected virtual IReportInstance<IReportTemplate> CreateReportInstanceOverride()
Returns
Type Description
IReportInstance<IReportTemplate>

An IReportInstance<TTemplate> for this template.

View Source

UseContext()

Starts a new context for this template.

Declaration
protected IDisposable UseContext()
Returns
Type Description
System.IDisposable

An System.IDisposable that defines the lifetime of the context.

Implements

IReportTemplate

Extension Methods

CollectionExtensions.AddRange<T, TCollection>(TCollection, IEnumerable<T>)
SerializableObjectCloneExtension.Clone<T>(T)

See Also

IReportTemplate
  • View Source
Back to top Generated by DocFX