XRControl Members
The base class for all visual controls used for creating reports.Constructors
| Name | Description |
|---|---|
| XRControl() | Initializes a new instance of the XRControl class with the default settings. |
Properties
| Name | Description |
|---|---|
| AccessibleDescription | Bindable. Gets or sets the description of a control used by assistive technologies. |
| Action | Specifies the action assigned to the control. |
| AnchorHorizontal | Specifies the horizontal anchoring type of a report control. |
| AnchorVertical | Specifies the vertical anchoring style of a report control. |
| BackColor | Gets or sets a 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. |
| Borders | Specifies a set of borders (top, right, bottom, left) that should be visible for the control. |
| BorderWidth | Specifies the width of cell borders in pixels, as a floating point value. |
| BottomF | Gets the Y-coordinate of the control’s bottom edge (measured in report units). |
| 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. |
| CanRaiseEvents protected | Gets a value indicating whether the component can raise an event. Inherited from Component. |
| CanShrink | Gets or sets a value that determines whether the height of a control can decrease if its content does not completely fill the control. |
| Container | Gets the IContainer that contains the Component. Inherited from Component. |
| 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. |
| DesignMode protected | Gets a value that indicates whether the Component is currently in design mode. Inherited from Component. |
| EvenStyleName | Gets or sets the style applied to the control when it displays an even record from the bound data source. |
| Events protected | Gets the list of event handlers that are attached to this Component. Inherited from Component. |
| 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. |
| 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. |
| 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. |
| LeftF | Specifies the X-coordinate of the control’s left edge (measured in report units). |
| 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 a control is clicked. |
| OddStyleName | Gets or sets the style applied to the control when it displays an odd record from the bound data source. |
| Padding | Gets or sets the control’s padding values (measured in report units). |
| Parent | Specifies the parent object that contains the current control. |
| Report | Provides access to the report that contains the control. |
| RightF | Gets the X-coordinate of the control’s right edge (measured in report units). |
| 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. |
| Site | Gets or sets the ISite of the Component. Inherited from Component. |
| 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. |
| StyleName | Gets or sets the name of the style, which is applied to the current control. |
| StylePriority | Allows you to specify properties whose values for an individual control have priority over the same properties specified for the style assigned to the 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 positioning of text within a control. |
| TopF | Gets or sets the Y-coordinate of the control’s top edge (measured in report units). |
| Visible | Gets or sets a value that specifies whether the report control is displayed in the document. |
| 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. |
| CreateObjRef(Type) | Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. Inherited from MarshalByRefObject. |
| Dispose() | Releases all resources used by the Component. Inherited from Component. |
| Equals(Object, Object) static | Determines whether the specified object instances are considered equal. Inherited from Object. |
| Equals(Object) | Determines whether the specified object is equal to the current object. Inherited from Object. |
| 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. |
| GetEffectiveBorders() | Returns the borders settings actually used as the control’s borders settings. |
| GetEffectiveBorderWidth() | Returns the border width settings actually used as the control’s current 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. |
| GetHashCode() | Serves as the default hash function. Inherited from Object. |
| GetLifetimeService() | Retrieves the current lifetime service object that controls the lifetime policy for this instance. Inherited from MarshalByRefObject. |
| GetService(Type) protected | Returns an object that represents a service provided by the Component or by its Container. Inherited from Component. |
| GetType() | Gets the Type of the current instance. Inherited from Object. |
| InitializeLifetimeService() | Obtains a lifetime service object to control the lifetime policy for this instance. Inherited from MarshalByRefObject. |
| MemberwiseClone() protected | Creates a shallow copy of the current Object. Inherited from Object. |
| MemberwiseClone(Boolean) protected | Creates a shallow copy of the current MarshalByRefObject object. Inherited from MarshalByRefObject. |
| PerformLayout() | Forces the control to apply layout logic to itself and all its child controls. |
| ReferenceEquals(Object, Object) static | Determines whether the specified Object instances are the same instance. Inherited from Object. |
| 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. |
| 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. |
| 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. |
| 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(DXTextRenderingHint) | Returns the graphical representation of a control created using the specified text rendering mode. |
| ToString() | Returns a String containing the name of the Component, if any. This method should not be overridden. Inherited from Component. |
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 generated. |
| Disposed | Occurs when the component is disposed by a call to the Dispose() method. Inherited from Component. |
| 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.LocationF 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.SizeF property is changed. |
| TextChanged | Occurs when the value of the XRControl.Text property is changed. |
See Also