Class ReportItem

Represents a report item, such as a rectangle or tablix.

Inheritance

System.Object

ReportItem

Namespace: BoldReports.RDL.DOM

Assembly: BoldReports.Web.dll

Syntax

public abstract class ReportItem : Object

Constructors

ReportItem()

Declaration

protected ReportItem()

Properties

ActionInfo

Gets or sets the action information associated with the element.

Declaration

public ActionInfo ActionInfo { get; set; }

Property Value

Type	Description
BoldReports.RDL.DOM.ActionInfo	An `ActionInfo` object detailing actions or interactions applicable to this element.

Bookmark

Gets or sets the bookmark identifier for this element.

Declaration

public string Bookmark { get; set; }

Property Value

Type	Description
System.String	A string indicating a bookmark location within a document.

CustomProperties

Gets or sets the custom properties associated with this element.

Declaration

public CustomProperties CustomProperties { get; set; }

Property Value

Type	Description
BoldReports.RDL.DOM.CustomProperties	A `CustomProperties` collection that holds custom metadata for this element.

DataElementName

Gets or sets the name used for data elements.

Declaration

public string DataElementName { get; set; }

Property Value

Type	Description
System.String	A string representing the name related to data elements in the report.

DataElementOutput

Gets or sets the output settings for data elements.

Declaration

public DataElementOutputs DataElementOutput { get; set; }

Property Value

Type	Description
BoldReports.RDL.DOM.DataElementOutputs	A `DataElementOutputs` enumeration value indicating how data elements are rendered.

DocumentMapLabel

Gets or sets the label for the document map.

Declaration

public string DocumentMapLabel { get; set; }

Property Value

Type	Description
System.String	A string representing a label used for navigation within a document map.

Height

Gets or sets the height of the element.

Declaration

public Size Height { get; set; }

Property Value

Type	Description
BoldReports.RDL.DOM.Size	A `Size` object representing the vertical dimension of this element.

LabelLocID

Gets or sets the localization ID for the label.

Declaration

public string LabelLocID { get; set; }

Property Value

Type	Description
System.String	A string used for accessing the localized label text.

Left

Declaration

public Size Left { get; set; }

Property Value

Type	Description
BoldReports.RDL.DOM.Size

Name

Gets or sets the name of the report element.

Declaration

public string Name { get; set; }

Property Value

Type	Description
System.String	A string representing the name identifier of this element.

RepeatWith

Gets or sets the repeat-with property for this element.

Declaration

public string RepeatWith { get; set; }

Property Value

Type	Description
System.String	A string that specifies fields for linking repeated elements.

ReportPartInfo

Gets or sets the report part information.

Declaration

public ReportPartInfo ReportPartInfo { get; set; }

Property Value

Type	Description
BoldReports.RDL.DOM.ReportPartInfo	A `ReportPartInfo` object containing metadata for report parts.

Style

Gets or sets the style properties of this element.

Declaration

public Style Style { get; set; }

Property Value

Type	Description
BoldReports.RDL.DOM.Style	A `Style` object encapsulating styling attributes such as font, color, and borders.

Gets or sets the tooltip for the element.

Declaration

public string ToolTip { get; set; }

Property Value

Type	Description
System.String	A string providing additional descriptive information shown on hover.

Top

Declaration

public Size Top { get; set; }

Property Value

Type	Description
BoldReports.RDL.DOM.Size

Value

Gets or sets the value associated with the report element.

Declaration

public string Value { get; set; }

Property Value

Type	Description
System.String	A string that stores data or a descriptive value relating to this element.

Visibility

Gets or sets the visibility settings for this element.

Declaration

public Visibility Visibility { get; set; }

Property Value

Type	Description
BoldReports.RDL.DOM.Visibility	A `Visibility` object determining whether the element is visible or hidden.

Width

Gets or sets the width of the element.

Declaration

public Size Width { get; set; }

Property Value

Type	Description
BoldReports.RDL.DOM.Size	A `Size` object representing the horizontal dimension of this element.

ZIndex

Gets or sets the z-index order of the element.

Declaration

public int ZIndex { get; set; }

Property Value

Type	Description
System.Int32	An integer representing the layering order of this element on a z-index.

Methods

ResetCustomProperties()

Resets the CustomProperties collection to a new instance.

Declaration

public void ResetCustomProperties()

ResetDataElementOutput()

Resets the DataElementOutput property to the default Auto value.

Declaration

public void ResetDataElementOutput()

ResetReportPartInfo()

Resets the ReportPartInfo property to a new instance.

Declaration

public void ResetReportPartInfo()

ResetVisibility()

Resets the Visibility property to a new instance.

Declaration

public void ResetVisibility()

ResetZIndex()

Resets the ZIndex property to the default value.

Declaration

public void ResetZIndex()

ShouldSerializeCustomProperties()

Determines whether the CustomProperties should be serialized.

Declaration

public bool ShouldSerializeCustomProperties()

Returns

Type	Description
System.Boolean	`true` if CustomProperties is not null and contains items; otherwise, `false`.

ShouldSerializeDataElementOutput()

Determines whether the DataElementOutput should be serialized.

Declaration

public bool ShouldSerializeDataElementOutput()

Returns

Type	Description
System.Boolean	`true` if DataElementOutput is not set to Auto; otherwise, `false`.

ShouldSerializeReportPartInfo()

Determines whether the ReportPartInfo should be serialized.

Declaration

public bool ShouldSerializeReportPartInfo()

Returns

Type	Description
System.Boolean	`true` if ReportPartInfo is not null and contains significant information; otherwise, `false`.

ShouldSerializeVisibility()

Determines whether the Visibility property should be serialized.

Declaration

public bool ShouldSerializeVisibility()

Returns

Type	Description
System.Boolean	`true` if Visibility is not null; otherwise, `false`.

ShouldSerializeZIndex()

Determines whether the ZIndex property should be serialized.

Declaration

public bool ShouldSerializeZIndex()

Returns

Type	Description
System.Boolean	`true` if the ZIndex is greater than 0; otherwise, `false`.