Class ProjectBase

Namespace

combit.Reporting.Dom

Assembly

combit.ListLabel31.CrossPlatform.dll

Cross-platform base class for all List & Label DOM project types. Provides lazy accessors for commonly used collections (objects, variables, parameters, layers, regions, fonts), layout & settings metadata, multi-pass evaluation helpers, template / subreport import logic, layer visibility evaluation and adjusted object bounds calculation used during rendering.

[JsonDerivedType(typeof(ProjectList), "list")]
[JsonDerivedType(typeof(ProjectCard), "card")]
[JsonDerivedType(typeof(ProjectLabel), "label")]
[JsonDerivedType(typeof(ProjectIndex), "index")]
[JsonDerivedType(typeof(ProjectReverseSide), "reverseSide")]
[JsonDerivedType(typeof(ProjectTableOfContents), "tableOfContents")]
public class ProjectBase : DomItem, IDisposable

Inheritance

object

DomItem

ProjectBase

Implements

IDisposable

Derived

ProjectCard

ProjectIndex

ProjectLabel

ProjectList

ProjectReverseSide

ProjectTableOfContents

Inherited Members

DomItem.NonFormulaPropertyCache

DomItem.domHandle

DomItem.InternalObjectType

DomItem.GenerateCode(CodeMemberMethod, string)

DomItem.CopyFrom(DomItem, bool)

DomItem.CopyFromWithEvaluate(DomItem, bool, bool)

DomItem.GetPropertyVirtualValue(string, string, ref bool)

DomItem.GetPropertyPath(string)

DomItem.GetVirtualVariableNames(string)

DomItem.GetNameAliasForVirtualProperty(string)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

Changed

Gets a value indicating whether the project has been changed since it was last saved.

[Browsable(false)]
[JsonIgnore]
public string? Changed { get; }

Property Value

string

EmbeddedFonts

Gets the collection of embedded fonts used in the project.

[JsonInclude]
public CollectionEmbeddedFonts EmbeddedFonts { get; }

Property Value

CollectionEmbeddedFonts

Filter

Gets or sets the filter expression for the project.

public string Filter { get; set; }

Property Value

string

IssueRanges

Gets or sets the issue ranges for the project.

public string IssueRanges { get; set; }

Property Value

string

Layers

Gets the collection of layers in the project.

[JsonInclude]
public CollectionLayers Layers { get; }

Property Value

CollectionLayers

Layout

Gets the layout properties of the project.

[JsonInclude]
public PropertyLayoutBase Layout { get; }

Property Value

PropertyLayoutBase

Objects

Gets the collection of objects contained in the project.

[JsonInclude]
public CollectionObjectBases Objects { get; }

Property Value

CollectionObjectBases

PageRanges

Gets or sets the page ranges for the project.

public string PageRanges { get; set; }

Property Value

string

ProjectMetadata

Gets project metadata containing information about the project format and versions.

public ProjectMetadata ProjectMetadata { get; set; }

Property Value

ProjectMetadata

ProjectParameters

Gets the collection of project parameters.

[JsonInclude]
public CollectionProjectParameters ProjectParameters { get; }

Property Value

CollectionProjectParameters

ProjectTemplates

Gets the collection of project templates associated with this project.

[JsonInclude]
public CollectionTemplates ProjectTemplates { get; }

Property Value

CollectionTemplates

Remarks

The ProjectTemplates property provides access to the collection of templates that are available for the current project. Templates can be used to define reusable layouts or objects that can be imported into other projects.

ProjectType

Gets the type of the List & Label project.

public LlProject ProjectType { get; protected set; }

Property Value

LlProject

Regions

Gets the collection of regions in the project.

[JsonInclude]
public CollectionRegions Regions { get; }

Property Value

CollectionRegions

ReportParameters

Gets the collection of report parameters in the project.

[JsonInclude]
public CollectionReportParameters ReportParameters { get; }

Property Value

CollectionReportParameters

ReportSections

Gets the report sections of the project.

[JsonInclude]
public PropertyReportSections ReportSections { get; }

Property Value

PropertyReportSections

Settings

Gets the settings for the project.

[JsonInclude]
public PropertySettings Settings { get; }

Property Value

PropertySettings

SumVariables

Gets the collection of sum variables in the project.

[JsonInclude]
public CollectionSumVariables SumVariables { get; }

Property Value

CollectionSumVariables

UserData

Gets or sets user-defined data for the project.

public string UserData { get; set; }

Property Value

string

UserDefinedDesignScheme

Gets or sets the user-defined design scheme for the project.

[JsonInclude]
public PropertyUserDefinedDesignScheme UserDefinedDesignScheme { get; }

Property Value

PropertyUserDefinedDesignScheme

UserVariables

Gets the collection of user variables in the project.

[JsonInclude]
public CollectionUserVariables UserVariables { get; }

Property Value

CollectionUserVariables

Methods

Dispose()

Releases all resources used by the ProjectBase class.

public void Dispose()

Dispose(bool)

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

protected virtual void Dispose(bool disposing)

Parameters

disposing bool

true to release both managed and unmanaged resources; false to release only unmanaged resources.

Save()

Saves the List & Label project to the default location or file.

public void Save()

Save(Stream)

Saves the List & Label project to the specified stream.

public void Save(Stream projectStream)

Parameters

projectStream Stream

The stream to which the project will be saved.

Save(string)

Saves the List & Label project to the specified file.

public void Save(string fileName)

Parameters

fileName string

The file name to save the project to.