XRControl Members

Constructors

Name Description
XRControl()

Initializes a new instance of the XRControl class with the default settings.

Properties

Name Description
AnchorHorizontal

Specifies the horizontal anchoring style of a report control.

AnchorVertical

Specifies the vertical anchoring style of a report control.

BackColor

Gets or sets the control's background color.

Band

Provides access to the owner band, in which the current control is situated.

Bookmark

Bindable. Gets or sets the text of a bookmark for this control.

BookmarkParent

Gets or sets the report control whose bookmark is the parent of the current bookmark.

BorderColor

Gets or sets the control's border color.

BorderDashStyle

Specifies the dash style for the control's border.

BorderWidth

Specifies the width of cell borders in pixels, as a floating point value.

Borders

Specifies a set of borders (top, right, bottom, left) that should be visible for the control.

Bottom

For internal use.

BottomF

Gets the Y-coordinate of the control's bottom edge (measured in report units).

Bounds

For internal use.

BoundsF

Specifies the location and size of a report element, according to the system of measurement selected for the report.

CanGrow

Gets or sets a value indicating whether the control's height can grow in order to display the content in its entirety.

CanHaveChildren

Gets a value indicating whether the control can contain other controls.

CanPublish

Specifies whether or not a report control is displayed in a printed or exported document.

CanShrink

Gets or sets a value indicating whether the control's height can decrease if its contents do not completely fill the control.

ControlType

For internal use.

Controls

Gets the collection of XRControl objects or their descendants that are contained in this control.

DataBindings

Provides access to the collection of a control's bindings.

Dock

Obsolete. For internal use.

Dpi

For internal use.

DrillDownKey

For internal use.

EvenStyleName

Gets or sets the current even style for the control.

ExpressionBindings

Provides access to a control's collection of expression bindings.

Font

Gets or sets the control's font.

ForeColor

Gets or sets the control's foreground color.

For internal use.

FormattingRules

Provides access to a collection of formatting rules applied to this control.

HasChildren

Gets a value indicating whether the control contains other XRControl objects.

Height

For internal use.

HeightF

Specifies the control's height (measured in report units).

Index

Gets the zero-based index of this control in its parent's collection of controls.

IsDisposed

For internal use. Gets a value indicating whether the control has been disposed of.

IsSingleChild

Checks whether the report element (control or band) is a single child of its parent.

KeepTogether

Specifies whether a control can be split across pages.

Left

For internal use.

LeftF

Specifies the X-coordinate of the control's left edge (measured in report units).

Location

For internal use.

LocationF

Specifies the floating-point representation of the coordinates of the control's upper-left corner.

LocationFloat

For internal use. Supports serialization of the XRControl.LocationF property.

LockedInUserDesigner

Gets or sets a value that specifies whether this control can be changed by an end-user in the End-User Designer.

Name

Gets or sets a name of the control.

NavigateUrl

Bindable. Specifies the URL to navigate to when the control is clicked.

NullValueText

For internal use.

OddStyleName

Gets or sets the current odd style for the control.

Padding

Gets or sets the control's padding values (measured in report units).

Parent

Gets or sets the parent object of this control.

ParentStyleUsing

For internal use.

ProcessDuplicates

Obsolete. For internal use.

ProcessDuplicatesMode

For internal use.

ProcessDuplicatesTarget

For internal use.

ProcessNullValues

For internal use.

Report

Provides access to the report that contains the control.

Right

For internal use.

RightF

Gets the X-coordinate of the control's right edge (measured in report units).

RightToLeft

For internal use.

RootReport

Provides access to the report to which the control belongs.

Scripts

Provides access to an object that contains XRControl-specific scripts to handle its events in the End-User Report Designer.

Size

For internal use.

SizeF

Gets or sets the size of the control.

SnapLineMargin

Specifies the control's margins that are maintained when the control is aligned using snap lines.

SnapLinePadding

Designed to be used internally. Use the XRPanel.SnapLinePadding or Band.SnapLinePadding property instead.

StyleName

Gets or sets the name of the style, which is applied to the current control.

StylePriority

Provides access to the settings that determine which properties of a style assigned to a control should override the corresponding properties of a control.

Styles

Gets a set of styles for the control.

Tag

Bindable. Gets or sets the object that contains data about this control.

Target

Specifies the target window or frame in which to display the linked Web page's content, when the control is clicked.

Text

Bindable. Specifies the control's text.

TextAlignment

Specifies the alignment of the control's text.

TextFormatString

Designed to be used internally. Use a specific control's TextFormatString property instead (e.g., XRLabel.TextFormatString, XRBarCode.TextFormatString or XRCheckBox.TextFormatString.

TextTrimming

For internal use.

Top

For internal use.

TopF

Gets or sets the Y-coordinate of the control's top edge (measured in report units).

Value

For internal use.

Visible

Gets or sets a value indicating whether or not the report control is displayed in a document.

Width

For internal use.

WidthF

Specifies the control's width (measured in report units).

WordWrap

Indicates whether a control automatically wraps words to the beginning of the next line when necessary.

XlsxFormatString

Specifies the native Excel format to be imported to the control's content after the report is exported to an Excel file (XLS or XLSX).

Methods

Name Description
AllControls<T>()

Returns a collection that contains all controls found within XRControl (within a report).

BringToFront()

Brings the control to the front of the z-order.

FindControl(String, Boolean)

Finds the control that has the specified name in the XRControl.Controls collection.

GetEffectiveBackColor()

Returns the color actually used as the control's background color.

GetEffectiveBorderColor()

Returns the color actually used as the control's border color.

GetEffectiveBorderDashStyle()

Returns the border dash style that is actually used by the control.

GetEffectiveBorderWidth()

Returns the border width settings actually used as the control's current settings.

GetEffectiveBorders()

Returns the borders settings actually used as the control's borders settings.

GetEffectiveFont()

Returns the font actually used as the control's font.

GetEffectiveForeColor()

Returns the color actually used as the control's foreground color.

GetEffectivePadding()

Returns the padding values actually used as the control's padding.

GetEffectiveStyle()

Returns the actual visual style of a control taking into account all formatting rules and odd/even styles applied to the control.

GetEffectiveTextAlignment()

Returns the text alignment actually used as the control's text alignment.

PerformLayout()

Forces the control to apply layout logic to itself and all its child controls.

RemoveInvalidBindings(Predicate<XRBinding>)

Removes inappropriate bindings assigned to the XRControl's properties.

ResetBackColor()

Resets the XRControl.BackColor property value, so that it is no longer stored in the current control and is obtained from its parent instead.

ResetBorderColor()

Resets the XRControl.BorderColor property value, so that it is no longer stored in the current control and is obtained from its parent instead.

ResetBorderDashStyle()

Resets the XRControl.BorderDashStyle property to en empty value.

ResetBorderWidth()

Resets the XRControl.BorderWidth property value, so that it is no longer stored in the current control and is obtained from its parent instead.

ResetBorders()

Resets the XRControl.Borders property value, so that it is no longer stored in the current control and is obtained from its parent instead.

ResetFont()

Resets the XRControl.Font property value, so that it is no longer stored in the current control and is obtained from its parent instead.

ResetForeColor()

Resets the XRControl.ForeColor property value, so that it is no longer stored in the current control and is obtained from its parent instead.

ResetPadding()

Resets the XRControl.Padding property value, so that it is no longer stored in the current control and is obtained from its parent instead.

ResetTextAlignment()

Resets the XRControl.TextAlignment property value, so that it is no longer stored in the current control and is obtained from its parent instead.

ResumeLayout()

Resumes normal layout logic for the control.

SendToBack()

Sends the control to the back of the z-order.

SuspendLayout()

Temporarily suspends the layout logic for the control.

ToImage()

Returns a graphical representation of a control.

ToImage(TextRenderingHint)

Returns a control's graphical representation created using the specified text rendering mode.

Events

Name Description
AfterPrint

Occurs after an XRControl object is displayed in the report.

BeforePrint

Occurs before an XRControl object creates its image in a report being previewed/printed/exported.

Draw

Occurs when an XRControl object is drawn or redrawn in a report's Print Preview.

EvaluateBinding

Occurs after a data-bound XRControl object obtains data from its data source.

HtmlItemCreated

Occurs when a new item used for a Web representation of the control is created.

LocationChanged

Occurs when the value of the XRControl.Location property is changed.

ParentChanged

Occurs when the XRControl instance's parent is changed.

PreviewClick

Occurs when the mouse button is clicked while the cursor is hovering over one of the bricks created by the XRControl for its representation in the report preview.

PreviewDoubleClick

Occurs when the left mouse button is double-clicked while the cursor is hovering over one of the bricks created for the control's representation in the report preview.

PreviewMouseDown

Occurs when an end-user presses the mouse button while the mouse pointer is hovering over one of the bricks created for the control's representation in the report preview.

PreviewMouseMove

Occurs when the mouse cursor moves over the control during the report's preview.

PreviewMouseUp

Occurs when an end-user releases the left mouse button while the mouse pointer is hovering over one of the bricks created for the control's representation in the report preview.

PrintOnPage

Occurs when the representation of a control is printed on the current page of the report.

SizeChanged

Occurs when the value of the XRControl.Size property is changed.

TextChanged

Occurs when the value of the XRControl.Text property is changed.