XRLabel Members
A Label control.Constructors
| Name | Description |
|---|---|
| XRLabel() | Initializes a new instance of the XRLabel class with the default settings. |
Properties
| Name | Description |
|---|---|
| AccessibleDescription | Bindable. Gets or sets the description of a control used by assistive technologies. Inherited from XRControl. |
| AccessibleRole |
Specifies the role of XRLabel and XRTableCell in the exported PDF document. This value is used by assistive technologies.
|
| Action | Specifies the action assigned to the control. Inherited from XRControl. |
| AllowMarkupText | Gets or sets whether you can use HTML-style markup tags to format the control’s text. |
| AnchorHorizontal | Specifies the horizontal anchoring type of a report control. Inherited from XRControl. |
| AnchorVertical | Specifies the vertical anchoring style of a report control. Inherited from XRControl. |
| Angle | Gets or sets the angle by which the XRLabel‘s text is rotated. |
| AutoWidth | Specifies whether or not the width of a label depends on its text. |
| BackColor | Gets or sets a control’s background color. Inherited from XRControl. |
| Band | Provides access to the owner band, in which the current control is situated. Inherited from XRControl. |
| Bookmark | Bindable. Gets or sets the text of a bookmark for this control. Inherited from XRControl. |
| BookmarkParent | Gets or sets the report control whose bookmark is the parent of the current bookmark. Inherited from XRControl. |
| BorderColor | Gets or sets the control’s border color. Inherited from XRControl. |
| BorderDashStyle | Specifies the dash style for the control’s border. Inherited from XRControl. |
| Borders | Specifies a set of borders (top, right, bottom, left) that should be visible for the control. Inherited from XRControl. |
| BorderWidth | Specifies the width of cell borders in pixels, as a floating point value. Inherited from XRControl. |
| BottomF | Gets the Y-coordinate of the control’s bottom edge (measured in report units). Inherited from XRControl. |
| BoundsF | Specifies the location and size of a report element, according to the system of measurement selected for the report. Inherited from XRControl. |
| CanGrow | Gets or sets a value indicating whether the label’s height can grow in order to display the contents in their entirety. |
| CanHaveChildren | Gets a value indicating whether the control can contain other controls. Inherited from XRControl. |
| CanPublish | Specifies whether or not a report control is displayed in a printed or exported document. Inherited from XRControl. |
| CanRaiseEvents protected | Gets a value indicating whether the component can raise an event. Inherited from Component. |
| CanShrink | Gets or sets a value indicating whether the label’s height can decrease if its text 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. Inherited from XRControl. |
| DataBindings | Provides access to the collection of a control’s bindings. Inherited from XRControl. |
| DefaultPadding static | Returns an object representing the default padding value for the XRLabel class. |
| DesignMode protected | Gets a value that indicates whether the Component is currently in design mode. Inherited from Component. |
| EditOptions | Provides access to options that define whether and how a control’s content can be edited in Print Preview. |
| EvenStyleName | Gets or sets the style applied to the control when it displays an even record from the bound data source. Inherited from XRControl. |
| 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. Inherited from XRControl. |
| Font | Gets or sets the control’s font. Inherited from XRControl. |
| ForeColor | Gets or sets the control’s foreground color. Inherited from XRControl. |
| FormattingRules | Provides access to a collection of formatting rules applied to this control. Inherited from XRControl. |
| HasChildren | Gets a value indicating whether the control contains other XRControl objects. Inherited from XRControl. |
| HeightF | Specifies the control’s height (measured in report units). Inherited from XRControl. |
| Index | Gets the zero-based index of this control in its parent’s collection of controls. Inherited from XRControl. |
| InteractiveSorting | Enables sorting a report in Print Preview by clicking the XRLabel. |
| IsDisposed | For internal use. Gets a value indicating whether the control has been disposed of. Inherited from XRControl. |
| IsSingleChild | Checks whether the report element (control or band) is a single child of its parent. Inherited from XRControl. |
| KeepTogether | Overrides the XRControl.KeepTogether property. |
| LeftF | Specifies the X-coordinate of the control’s left edge (measured in report units). Inherited from XRControl. |
| LocationF | Specifies the floating-point representation of the coordinates of the control’s upper-left corner. Inherited from XRControl. |
| LocationFloat | For internal use. Supports serialization of the XRControl.LocationF property. Inherited from XRControl. |
| LockedInUserDesigner | Gets or sets a value that specifies whether this control can be changed by an end-user in the End-User Designer. Inherited from XRControl. |
| Multiline | Gets or sets whether carriage return (CRLF) characters split the label’s text into multiple lines. |
| Name | Gets or sets a name of the control. Inherited from XRControl. |
| NavigateUrl | Bindable. Specifies the URL to navigate to when a control is clicked. Inherited from XRControl. |
| NullValueText | Specifies the text shown by the XRLabel when the value of its bound data field is null. |
| OddStyleName | Gets or sets the style applied to the control when it displays an odd record from the bound data source. Inherited from XRControl. |
| Padding | Gets or sets the control’s padding values (measured in report units). Inherited from XRControl. |
| Parent | Specifies the parent object that contains the current control. Inherited from XRControl. |
| ProcessDuplicatesMode | Specifies how to process a XRLabel control with duplicate values. See the ProcessDuplicatesMode enumeration description for information on the different duplicate processing modes. |
| ProcessDuplicatesTarget | Specifies whether to process duplicate values of the XRControl.Text, or XRControl.Tag property. |
| ProcessNullValues | Specifies how to process a XRLabel control with null values. See the ValueSuppressType enumeration description for information on how different modes process null values. |
| Report | Provides access to the report that contains the control. Inherited from XRControl. |
| RightF | Gets the X-coordinate of the control’s right edge (measured in report units). Inherited from XRControl. |
| RightToLeft | Specifies the orientation of the XRLabel‘s content. |
| RootReport | Provides access to the report to which the control belongs. Inherited from XRControl. |
| Scripts | Provides access to an object that contains XRLabel-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. Inherited from XRControl. |
| SnapLineMargin | Specifies the control’s margins that are maintained when the control is aligned using snap lines. Inherited from XRControl. |
| StyleName | Gets or sets the name of the style, which is applied to the current control. Inherited from XRControl. |
| 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. Inherited from XRControl. |
| Styles | Gets a set of styles for the control. Inherited from XRControl. |
| Summary | Gets the value that was calculated for the data source field bound to the XRControl.Text property of the given label. |
| Tag | Bindable. Gets or sets the object that contains data about this control. Inherited from XRControl. |
| Target | Specifies the target window or frame in which to display the linked Web page’s content, when the control is clicked. Inherited from XRControl. |
| Text | Bindable. Specifies the control’s text. Inherited from XRFieldEmbeddableControl. |
| TextAlignment | Specifies the positioning of text within a control. Inherited from XRControl. |
| TextFitMode | Specifies how text is resized to fit a control. This property has limitations when working with other properties. |
| TextFormatString | Specifies the output format for a value bound to the label. |
| TextTrimming | Specifies the trimming mode applied to text when it does not completely fit into the label. |
| TopF | Gets or sets the Y-coordinate of the control’s top edge (measured in report units). Inherited from XRControl. |
| Value | Specifies a label’s actual value. |
| Visible | Gets or sets a value that specifies whether the report control is displayed in the document. Inherited from XRControl. |
| WidthF | Specifies the control’s width (measured in report units). Inherited from XRControl. |
| WordWrap | Indicates whether a control automatically wraps words to the beginning of the next line when necessary. Inherited from XRControl. |
| 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). Inherited from XRControl. |
Methods
| Name | Description |
|---|---|
| AllControls<T>() | Returns a collection that contains all controls found within XRControl (within a report). Inherited from XRControl. |
| BringToFront() | Brings the control to the front of the z-order. Inherited from XRControl. |
| 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. Inherited from XRControl. |
| GetEffectiveBackColor() | Returns the color actually used as the control’s background color. Inherited from XRControl. |
| GetEffectiveBorderColor() | Returns the color actually used as the control’s border color. Inherited from XRControl. |
| GetEffectiveBorderDashStyle() | Returns the border dash style that is actually used by the control. Inherited from XRControl. |
| GetEffectiveBorders() | Returns the borders settings actually used as the control’s borders settings. Inherited from XRControl. |
| GetEffectiveBorderWidth() | Returns the border width settings actually used as the control’s current settings. Inherited from XRControl. |
| GetEffectiveFont() | Returns the font actually used as the control’s font. Inherited from XRControl. |
| GetEffectiveForeColor() | Returns the color actually used as the control’s foreground color. Inherited from XRControl. |
| GetEffectivePadding() | Returns the padding values actually used as the control’s padding. Inherited from XRControl. |
| GetEffectiveStyle() | Returns the actual visual style of a control taking into account all formatting rules and odd/even styles applied to the control. Inherited from XRControl. |
| GetEffectiveTextAlignment() | Returns the text alignment actually used as the control’s text alignment. Inherited from XRControl. |
| 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. Inherited from XRControl. |
| 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. Inherited from XRControl. |
| 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. Inherited from XRControl. |
| 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. Inherited from XRControl. |
| ResetBorderDashStyle() | Resets the XRControl.BorderDashStyle property to en empty value. Inherited from XRControl. |
| 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. Inherited from XRControl. |
| 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. Inherited from XRControl. |
| 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. Inherited from XRControl. |
| 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. Inherited from XRControl. |
| 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. Inherited from XRControl. |
| 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. Inherited from XRControl. |
| ResumeLayout() | Resumes normal layout logic for the control. Inherited from XRControl. |
| SendToBack() | Sends the control to the back of the z-order. Inherited from XRControl. |
| SuspendLayout() | Temporarily suspends the layout logic for the control. Inherited from XRControl. |
| ToImage() | Returns a graphical representation of a control. Inherited from XRControl. |
| ToImage(DXTextRenderingHint) | Returns the graphical representation of a control created using the specified text rendering mode. Inherited from XRControl. |
| 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. Inherited from XRControl. |
| BeforePrint | Occurs before an XRControl object creates its image in a report being generated. Inherited from XRControl. |
| 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. Inherited from XRControl. |
| EvaluateBinding | Occurs after a data-bound XRControl object obtains data from its data source. Inherited from XRControl. |
| HtmlItemCreated | Occurs when a new item used for a Web representation of the control is created. Inherited from XRControl. |
| LocationChanged | Occurs when the value of the XRControl.LocationF property is changed. Inherited from XRControl. |
| ParentChanged | Occurs when the XRControl instance’s parent is changed. Inherited from XRControl. |
| 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. Inherited from XRControl. |
| 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. Inherited from XRControl. |
| 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. Inherited from XRControl. |
| PreviewMouseMove | Occurs when the mouse cursor moves over the control during the report’s preview. Inherited from XRControl. |
| 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. Inherited from XRControl. |
| PrintOnPage | Occurs when the representation of a control is printed on the current page of the report. Inherited from XRControl. |
| SizeChanged | Occurs when the value of the XRControl.SizeF property is changed. Inherited from XRControl. |
| SummaryCalculated | Occurs when the automatic summary value of a label has been calculated. |
| SummaryGetResult | Occurs when a summary gets its final value. |
| SummaryReset | Occurs when the summary value needs to be set to its initial value when calculating a custom summary. |
| SummaryRowChanged | Occurs when a report retrieves the next data row in the bound data source. |
| TextChanged | Occurs when the value of the XRControl.Text property is changed. Inherited from XRControl. |
See Also