Class ReportParameter

Namespace

combit.Reporting.Dom

Assembly

combit.ListLabel31.CrossPlatform.dll

Represents a report parameter (prompt variable) with metadata like identifier, prompt, source and default values.

public sealed class ReportParameter : DomItemWithTemplateId, IEquatable<ReportParameter>

Inheritance

object

DomItem

DomItemWithTemplateId

ReportParameter

Implements

IEquatable<ReportParameter>

Inherited Members

DomItemWithTemplateId.TemplateUUID

DomItem.InternalObjectType

DomItem.GenerateCode(CodeMemberMethod, string)

DomItem.CopyFrom(DomItem, bool)

DomItem.CopyFromWithEvaluate(DomItem, bool, bool)

DomItem.GetPropertyPath(string)

DomItem.GetVirtualVariableNames(string)

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

ReportParameter(CollectionReportParameters)

Creates and appends a new report parameter.

public ReportParameter(CollectionReportParameters reportParametersCollection)

Parameters

reportParametersCollection CollectionReportParameters

Owning collection.

ReportParameter(CollectionReportParameters, int)

Creates and inserts a new report parameter at a specific index.

public ReportParameter(CollectionReportParameters reportParametersCollection, int index)

Parameters

reportParametersCollection CollectionReportParameters

Owning collection.

index int

Insertion index.

Properties

AllowBlank

Gets or sets whether blank values are allowed.

public string AllowBlank { get; set; }

Property Value

string

AllowMultipleValues

Gets or sets whether multiple values are allowed.

public string AllowMultipleValues { get; set; }

Property Value

string

AllowNull

Gets or sets whether null values are allowed.

public string AllowNull { get; set; }

Property Value

string

ControlType

Gets or sets the UI control type.

public LlDomControlType ControlType { get; set; }

Property Value

LlDomControlType

CurrentContentsAsExpressionValue

public ExpressionValue CurrentContentsAsExpressionValue { get; }

Property Value

ExpressionValue

DefaultValues

Gets the default value list.

[JsonInclude]
public PropertyDefaultValues DefaultValues { get; }

Property Value

PropertyDefaultValues

Id

Gets or sets the internal id.

public string Id { get; set; }

Property Value

string

Identifier

Gets or sets the textual identifier.

public string Identifier { get; set; }

Property Value

string

ImmediateRendering

Gets or sets whether immediate rendering is enabled.

public string ImmediateRendering { get; set; }

Property Value

string

ParentId

Gets or sets the parent parameter id (for cascading parameters).

public string ParentId { get; set; }

Property Value

string

Prompt

Gets or sets the user prompt text.

public string Prompt { get; set; }

Property Value

string

Source

Gets the data source configuration.

[JsonInclude]
public PropertySource Source { get; }

Property Value

PropertySource

Tag

Gets or sets an optional tag.

public string Tag { get; set; }

Property Value

string

Tooltip

Gets or sets the tooltip text.

public string Tooltip { get; set; }

Property Value

string

Visible

Gets or sets the visibility flag.

public string Visible { get; set; }

Property Value

string

Methods

Equals(object?)

Determines whether the specified object is equal to the current object.

public override bool Equals(object? obj)

Parameters

obj object

The object to compare with the current object.

Returns

bool

true if the specified object is equal to the current object; otherwise, false.

Equals(ReportParameter?)

Indicates whether the current object is equal to another object of the same type.

public bool Equals(ReportParameter? other)

Parameters

other ReportParameter

An object to compare with this object.

Returns

bool

true if the current object is equal to the other parameter; otherwise, false.

GetHashCode()

Serves as the default hash function.

public override int GetHashCode()

Returns

int

A hash code for the current object.