XtraReportBase Members

The base for XtraReport and DetailReportBand classes.

Properties

Name Description
AnchorHorizontal For internal use.
(Inherited from Band)
AnchorVertical For internal use.
(Inherited from Band)
BackColor Gets or sets the control's background color.
(Inherited from XRControl)
Band Provides access to the owner band, in which the current control is situated.
(Inherited from XRControl)
Bands Gets the collection of bands contained in a report.
Bookmark For internal use.
(Inherited from Band)
BookmarkParent For internal use.
(Inherited from Band)
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)
Bottom For internal use.
(Inherited from XRControl)
BottomF For internal use.
(Inherited from Band)
Bounds For internal use.
(Inherited from XRControl)
BoundsF For internal use.
(Inherited from Band)
CanGrow For internal use.
(Inherited from Band)
CanHaveChildren Overrides the XRControl.CanHaveChildren property.
(Inherited from Band)
CanPublish For internal use.
(Inherited from Band)
CanRaiseEvents protected Gets a value indicating whether the component can raise an event.
(Inherited from Component)
CanShrink For internal use.
(Inherited from Band)
Container Gets the IContainer that contains the Component.
(Inherited from Component)
Controls For internal use.
ControlType For internal use.
(Inherited from XRControl)
CurrentRowHierarchyLevel
CurrentRowIndex Gets the index of the current data row in a report's XtraReportBase.DataSource.
DataAdapter Specifies the data adapter that should be used to populate a report's data source.
DataBindings For internal use.
(Inherited from Band)
DataMember Gets or sets a specific list in a report's data source.
DataSource Gets or sets a data source object that provides data for a master or detail report, as well as to the charts and pivot grids it contains.
DesignMode protected Gets a value that indicates whether the Component is currently in design mode.
(Inherited from Component)
DetailPrintCount Obsolete. For internal use.
DetailPrintCountOnEmptyDataSource Obsolete. Use the DetailCountOnEmptyDataSource property instead.
Dock Obsolete. For internal use.
(Inherited from XRControl)
Dpi For internal use.
(Inherited from XRControl)
DrillDownKey For internal use.
(Inherited from XRControl)
EvenStyleName For internal use.
Events protected Gets the list of event handlers that are attached to this Component.
(Inherited from Component)
Expanded For internal use.
(Inherited from Band)
ExpressionBindings Provides access to a control's collection of expression bindings.
(Inherited from XRControl)
FilterString Specifies the criteria used to filter data in a report.
Font Gets or sets the control's font.
(Inherited from XRControl)
ForeColor Gets or sets the control's foreground color.
(Inherited from XRControl)
FormattingRuleLinks For internal use.
(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)
Height For internal use.
(Inherited from XRControl)
HeightF For internal use.
Index Gets the zero-based index of this control in its parent's collection of controls.
(Inherited from XRControl)
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 For internal use.
Left For internal use.
(Inherited from XRControl)
LeftF For internal use.
(Inherited from Band)
Location For internal use.
(Inherited from XRControl)
LocationF For internal use.
(Inherited from Band)
LocationFloat For internal use.
(Inherited from Band)
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)
Name Gets or sets a name of the control.
(Inherited from XRControl)
NavigateUrl For internal use.
(Inherited from Band)
NullValueText For internal use.
(Inherited from XRControl)
OddStyleName For internal use.
Padding Gets or sets the control's padding values (measured in report units).
(Inherited from XRControl)
PageBreak Gets or sets a value that determines where to make a page break, in respect to the given band.
(Inherited from Band)
Parent Specifies the parent object that contains the current control.
(Inherited from XRControl)
ParentStyleUsing For internal use.
(Inherited from XRControl)
PrintAcrossBands For internal use.
(Inherited from Band)
PrintOnEmptyDataSource Obsolete. Use the PrintOnEmptyDataSource property instead.
ProcessDuplicates Obsolete. For internal use.
(Inherited from XRControl)
ProcessDuplicatesMode For internal use.
(Inherited from XRControl)
ProcessDuplicatesTarget For internal use.
(Inherited from XRControl)
ProcessNullValues For internal use.
(Inherited from XRControl)
Report Provides access to the report that contains the control.
(Inherited from XRControl)
ReportPrintOptions Provides access to options that define a report's print-out.
Right For internal use.
(Inherited from XRControl)
RightF For internal use.
(Inherited from Band)
RightToLeft For internal use.
(Inherited from XRControl)
RootReport Provides access to the report to which the control belongs.
(Inherited from XRControl)
RowCount Gets the total amount of data rows in a report's XtraReportBase.DataSource.
Scripts Provides access to the report's scripts.
Site Gets or sets the ISite of the Component.
(Inherited from Component)
Size For internal use.
(Inherited from XRControl)
SizeF For internal use.
(Inherited from Band)
SnapLineMargin For internal use.
(Inherited from Band)
SnapLinePadding For internal use.
StyleName For internal use.
StylePriority For internal use.
Styles For internal use.
SubBands For internal use.
Tag Bindable. Gets or sets the object that contains data about this control.
(Inherited from XRControl)
Target For internal use.
(Inherited from Band)
Text For internal use.
(Inherited from Band)
TextAlignment Specifies the alignment of the control's text.
(Inherited from XRControl)
TextFormatString Designed to be used internally. Use a specific control's TextFormatString property instead (e.g., XRLabel.TextFormatString, XRBarCode.TextFormatString or XRCheckBox.TextFormatString.
(Inherited from XRControl)
TextTrimming For internal use.
(Inherited from XRControl)
Top For internal use.
(Inherited from XRControl)
TopF For internal use.
(Inherited from Band)
Value For internal use.
(Inherited from XRControl)
Visible Gets or sets a value indicating whether or not the report control is displayed in a document.
(Inherited from XRControl)
Width For internal use.
(Inherited from XRControl)
WidthF For internal use.
(Inherited from Band)
WordWrap For internal use.
(Inherited from Band)
XlsxFormatString For internal use.
(Inherited from Band)
XmlDataPath Specifies the path to an XML file that should be used as the report's data source.

Methods

Name Description
AllControls<T>() Returns a collection that contains all controls found within XRControl (within a report).
(Inherited from XRControl)
ApplyFiltering() Applies the filter string assigned to the XtraReportBase.FilterString property, to a report's data source using the current values of parameters.
BringToFront() Brings the control to the front of the z-order.
(Inherited from XRControl)
CreateBand(BandKind) static Creates a band of the specified type.
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) Determines whether the specified object is equal to the current object.
(Inherited from Object)
Equals(Object, Object) static Determines whether the specified object instances are considered equal.
(Inherited from Object)
FillDataSource() Populates a data source, which is assigned to a report's XtraReportBase.DataSource property.
FindControl(String, Boolean) Finds the control that has the specified name in the XRControl.Controls collection.
(Inherited from XRControl)
FromDisplayName(String) Obtains the real name of a data field, based on the field's display name.
GetCurrentColumnValue(String) Gets the current value of the specified column in the report's DataSource.
GetCurrentColumnValue<T>(String) Gets the current value (strongly typed) of the specified column in the report's DataSource.
GetCurrentRow() Returns the currently processed data row from the report's DataSource.
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)
GetNextColumnValue(String) Gets the next value of the specified column in the report's XtraReportBase.DataSource.
GetNextColumnValue<T>(String) Gets the next value (strongly typed) of the specified column in the report's XtraReportBase.DataSource.
GetNextRow() Returns the next data row in the report's data source.
GetPreviousColumnValue(String) Gets the previous value of the specified column in the report's XtraReportBase.DataSource.
GetPreviousColumnValue<T>(String) Gets the previous value (strongly typed) of the specified column in the report's XtraReportBase.DataSource.
GetPreviousRow() Returns the previous data row in the report's data source.
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)
IterateReportsRecursive(Action<XtraReportBase>) For internal use.
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() Replaces the XRControl.ToImage method.
(Inherited from Band)
ToImage(TextRenderingHint) Replaces the XRControl.ToImage method.
(Inherited from Band)
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)
BandHeightChanged Occurs when the height of any band in the collection returned by the XtraReportBase.Bands property changes.
BeforePrint Occurs before an XRControl object creates its image in a report being generated.
(Inherited from XRControl)
DataSourceDemanded Occurs before report generation, to specify a data source for the report.
DataSourceRowChanged Occurs when the current row in the report's data source has been changed.
Disposed Occurs when the component is disposed by a call to the Dispose() method.
(Inherited from Component)
Draw Overrides the XRControl.Draw event.
(Inherited from Band)
EvaluateBinding Overrides the XRControl.EvaluateBinding event to hide it.
(Inherited from Band)
HeightChanged Occurs when the band height is changed.
(Inherited from Band)
HtmlItemCreated Overrides the XRControl.HtmlItemCreated event.
(Inherited from Band)
LocationChanged Overrides the XRControl.LocationChanged event.
(Inherited from Band)
ParentChanged Overrides the XRControl.ParentChanged event.
(Inherited from Band)
PreviewClick Hides the inappropriate XRControl.PreviewClick event of the parent XRControl class.
(Inherited from Band)
PreviewDoubleClick Hides the inappropriate XRControl.PreviewDoubleClick event of the parent XRControl class.
(Inherited from Band)
PreviewMouseDown Hides the inappropriate XRControl.PreviewMouseDown event of the parent XRControl class.
(Inherited from Band)
PreviewMouseMove Hides the inappropriate XRControl.PreviewMouseMove event of the parent XRControl class.
(Inherited from Band)
PreviewMouseUp Hides the inappropriate XRControl.PreviewMouseUp event of the parent XRControl class.
(Inherited from Band)
PrintOnPage Overrides the XRControl.PrintOnPage event to hide it.
(Inherited from Band)
SizeChanged Overrides the XRControl.SizeChanged event.
(Inherited from Band)
TextChanged Overrides the XRControl.TextChanged event.
(Inherited from Band)
See Also