Back to Devexpress

XRChart Members

xtrareports-devexpress-dot-xtrareports-dot-ui-dot-xrchart-dot-underscore-members.md

latest49.8 KB
Original Source

XRChart Members

A Chart control.

Constructors

NameDescription
XRChart()Initializes a new instance of the XRChart class with the default settings.

Properties

NameDescription
AccessibleDescriptionBindable. Gets or sets the description of a control used by assistive technologies. Inherited from XRControl.
ActionSpecifies the action assigned to the control. Inherited from XRControl.
AnchorHorizontalSpecifies the horizontal anchoring type of a report control. Inherited from XRControl.
AnchorVerticalSpecifies the vertical anchoring style of a report control. Inherited from XRControl.
AnnotationRepositoryProvides centralized access to all annotations present in a chart.
AnnotationsProvides access to the chart’s collection of annotations.
AppearanceNameGets or sets the appearance name currently used to draw the chart’s elements.
AppearanceRepositoryProvides access to the repository of a chart’s appearance settings.
AutoLayoutSpecifies whether the adaptive layout feature is enabled for chart elements in the chart control.
BackColorGets or sets the chart control’s background color.
BackImageGets the background image settings of the chart control.
BandProvides access to the owner band, in which the current control is situated. Inherited from XRControl.
BookmarkBindable. Gets or sets the text of a bookmark for this control. Inherited from XRControl.
BookmarkParentGets or sets the report control whose bookmark is the parent of the current bookmark. Inherited from XRControl.
BorderColorGets or sets the control’s border color. Inherited from XRControl.
BorderDashStyleSpecifies the dash style for the control’s border. Inherited from XRControl.
BordersSpecifies a set of borders (top, right, bottom, left) that should be visible for the control. Inherited from XRControl.
BorderWidthSpecifies the width of cell borders in pixels, as a floating point value. Inherited from XRControl.
BottomFGets the Y-coordinate of the control’s bottom edge (measured in report units). Inherited from XRControl.
BoundsFSpecifies the location and size of a report element, according to the system of measurement selected for the report. Inherited from XRControl.
CanGrowGets or sets a value indicating whether the control’s height can grow in order to display the content in its entirety. Inherited from XRControl.
CanHaveChildrenGets a value indicating whether the control can contain other controls. Inherited from XRControl.
CanPublishOptionsSpecifies report control visibility on printouts and in documents exported to specific formats. Inherited from XRControl.
CanRaiseEvents protectedGets a value indicating whether the component can raise an event. Inherited from Component.
CanShrinkGets or sets a value that determines whether the height of a control can decrease if its content does not completely fill the control. Inherited from XRControl.
ContainerGets the IContainer that contains the Component. Inherited from Component.
ControlsGets the collection of XRControl objects or their descendants that are contained in this control. Inherited from XRControl.
DataAdapterGets or sets the data adapter used to populate the chart control’s data source.
DataBindingsProvides access to the collection of a control’s bindings. Inherited from XRControl.
DataMemberSpecifies the data source member which supplies data to the control.
DataSourceGets or sets the chart control’s data source. If it’s empty, then the report’s data source will be used.
DesignMode protectedGets a value that indicates whether the Component is currently in design mode. Inherited from Component.
DiagramGets the chart control’s diagram and provides access to its settings.
EmptyChartTextProvides access to the settings of the text to be displayed in the XRChart, when it has no data to display.
EvenStyleNameGets or sets the style applied to the control when it displays an even record from the bound data source. Inherited from XRControl.
Events protectedGets the list of event handlers that are attached to this Component. Inherited from Component.
ExpressionBindingsProvides access to a control’s collection of expression bindings. Inherited from XRControl.
FillStyleGets the chart control’s background fill style.
FormattingRulesProvides access to a collection of formatting rules applied to this control. Inherited from XRControl.
HasChildrenGets a value indicating whether the control contains other XRControl objects. Inherited from XRControl.
HeightFSpecifies the control’s height (measured in report units). Inherited from XRControl.
ImageTypeSpecifies how XRChart contents are rendered.
IndexGets the zero-based index of this control in its parent’s collection of controls. Inherited from XRControl.
IndicatorsPaletteNameSpecifies the palette that is used to paint all indicators that exist in a chart control.
IndicatorsPaletteRepositoryGets the indicators palette repository of the chart.
IsDisposedFor internal use. Gets a value indicating whether the control has been disposed of. Inherited from XRControl.
IsSingleChildChecks whether the report element (control or band) is a single child of its parent. Inherited from XRControl.
LeftFSpecifies the X-coordinate of the control’s left edge (measured in report units). Inherited from XRControl.
LegendGets the chart control’s legend and provides access to its settings.
LegendsReturns a collection of additional legends.
LocationFSpecifies the floating-point representation of the coordinates of the control’s upper-left corner. Inherited from XRControl.
LocationFloatFor internal use. Supports serialization of the XRControl.LocationF property. Inherited from XRControl.
LockedInUserDesignerGets or sets a value that specifies whether this control can be changed by an end-user in the End-User Designer. Inherited from XRControl.
NameGets or sets a name of the control. Inherited from XRControl.
NavigateUrlBindable. Specifies the URL to navigate to when a control is clicked. Inherited from XRControl.
OddStyleNameGets or sets the style applied to the control when it displays an odd record from the bound data source. Inherited from XRControl.
PaddingOverrides the XRControl.Padding property.
PaletteBaseColorNumberGets or sets the number of a color within the selected palette, which will be used as a base color to paint series points.
PaletteNameGets or sets the name of the palette which is currently being used to draw the chart’s elements.
PaletteRepositoryGets the palette repository of the chart.
ParametersProvides access to the chart’s parameters collection.
ParentSpecifies the parent object that contains the current control. Inherited from XRControl.
PivotGridDataSourceOptionsProvides access to the layout settings of a Chart that is linked with a Pivot Grid.
ReportProvides access to the report that contains the control. Inherited from XRControl.
RightFGets the X-coordinate of the control’s right edge (measured in report units). Inherited from XRControl.
RightToLeftSpecifies the orientation of the XRChart‘s content.
RootReportProvides access to the report to which the control belongs. Inherited from XRControl.
ScriptsProvides access to an object that contains XRChart-specific scripts to handle its events in the End-User Report Designer.
SeriesProvides access to the chart’s collection of series objects.
SeriesDataMemberGets or sets the name of the data field whose values are used to automatically generate and populate series.
SeriesNameTemplateGets the settings used to name data bound series.
SeriesSortingGets or sets a value that specifies how series are sorted within the chart control based upon the series names.
SeriesTemplateGets the template settings for bound series.
SiteGets or sets the ISite of the Component. Inherited from Component.
SizeFGets or sets the size of the control. Inherited from XRControl.
SmallChartTextGets the settings for the text to be displayed in the XRChart, when it’s too small to fit the diagram.
SnapLineMarginSpecifies the control’s margins that are maintained when the control is aligned using snap lines. Inherited from XRControl.
StyleNameGets or sets the name of the style, which is applied to the current control. Inherited from XRControl.
StylePriorityAllows 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.
TagBindable. Gets or sets the object that contains data about this control. Inherited from XRControl.
TargetSpecifies the target window or frame in which to display the linked Web page’s content, when the control is clicked. Inherited from XRControl.
TitlesGets the collection of chart titles.
TopFGets or sets the Y-coordinate of the control’s top edge (measured in report units). Inherited from XRControl.
VisibleGets or sets a value that specifies whether the report control is displayed in the document. Inherited from XRControl.
WidthFSpecifies the control’s width (measured in report units). Inherited from XRControl.

Methods

NameDescription
AllControls<T>()Returns a collection that contains all controls found within XRControl (within a report). Inherited from XRControl.
BeginInit()Starts the XRChart‘s initialization. Initialization occurs at runtime.
BindToData(SeriesViewBase, Object, String, String, String, String[])Binds a chart to data.
BindToData(SeriesViewBase, Object, String, String, String[])Binds a chart to data.
BindToData(ViewType, Object, String, String, String, String[])Binds a chart to data.
BindToData(ViewType, Object, String, String, String[])Binds a chart to data.
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.
EndInit()Ends the XRChart‘s initialization.
Equals(Object, Object) staticDetermines 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.
GetAppearanceNames()Returns an array of strings representing the names of all the appearances in the Chart.
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.
GetPaletteEntries(Int32)Gets the colors that comprise the chart’s palette.
GetPaletteNames()Returns an array of strings that represent the names of all the palettes in the Chart.
GetSeriesByName(String)Gets a series within the chart’s series collection by its name.
GetService(Type) protectedReturns 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.
LoadFromFile(String)Restores the chart’s layout from the specified file.
LoadFromStream(Stream)Restores the chart’s layout from the specified stream.
MemberwiseClone() protectedCreates a shallow copy of the current Object. Inherited from Object.
MemberwiseClone(Boolean) protectedCreates 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) staticDetermines whether the specified Object instances are the same instance. Inherited from Object.
RegisterGlobalSummaryFunction(String, String, Nullable<ScaleType>, Int32, SummaryFunctionArgumentDescription[], SummaryFunction) staticRegisters the custom summary function with the specified settings for all XRChart controls in the application.
RegisterSummaryFunction(String, String, ScaleType, Int32, SummaryFunctionArgumentDescription[], SummaryFunction)Obsolete. Registers the custom summary function with the specified settings.
RegisterSummaryFunction(String, String, Int32, SummaryFunctionArgumentDescription[], SummaryFunction)Obsolete. Registers the custom summary function with the specified settings.
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.
ResetLegendPointOptions()Obsolete. Cancels the changes applied to the SeriesBase.LegendPointOptions for each series, and makes it equal to the SeriesBase.PointOptions.
ResetLegendTextPattern()Resets the text pattern applied to the legend items via the SeriesBase.LegendTextPattern property.
ResetPadding()Resets the XRChart.Padding property to an empty value.
ResetSummaryFunctions()Obsolete. Resets the collection of the chart’s summary functions.
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.
SaveToFile(String)Saves the chart’s layout to the specified file.
SaveToStream(Stream)Saves the chart’s layout to the specified stream.
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.
UnregisterGlobalSummaryFunction(String) staticUnregisters the summary function with the specified name.
UnregisterSummaryFunction(String)Obsolete. Unregisters the summary function with the specified name.

Events

NameDescription
AfterPrintOccurs after an XRControl object is displayed in the report. Inherited from XRControl.
AxisScaleChangedOccurs when the scale mode, measure unit, grid alignment or grid spacing of the axis scale has been changed.
AxisVisualRangeChangedOccurs when the axis visual range has been changed.
AxisWholeRangeChangedOccurs when the axis whole range has been changed.
BeforePrintOccurs before an XRControl object creates its image in a report being generated. Inherited from XRControl.
BoundDataChangedOccurs every time a chart control generates its series points from the underlying data source.
CustomDrawAxisLabelOccurs before an axis label is drawn when the chart’s content is being drawn.
CustomDrawCrosshairOccurs before crosshair items are drawn when the chart’s contents are being drawn.
CustomDrawSeriesOccurs before a series is drawn when the chart’s contents are being drawn.
CustomDrawSeriesPointOccurs before a series point is drawn when the chart’s contents is being drawn.
CustomizeAutoBindingSettingsOccurs when applying automatic data source settings to a Chart that is linked to a Pivot Grid.
CustomizeLegendObsolete. Occurs before automatic settings are applied to the legend‘s layout properties.
CustomizePieTotalLabelOccurs before the pie total label is painted.
CustomizeResolveOverlappingModeObsolete. Occurs before an automatic setting is applied to the overlap resolving mode of series labels.
CustomizeSimpleDiagramLayoutOccurs before automatic settings are applied to the Simple Diagram‘s layout properties.
CustomizeStackedBarTotalLabelOccurs before a stacked bar total label is painted.
CustomizeXAxisLabelsObsolete. Occurs after automatic layout settings are applied to the X-axis’ labels.
CustomPaintAllows you to draw custom graphics on top of the chart.
Deserialized
DisposedOccurs when the component is disposed by a call to the Dispose() method. Inherited from Component.
DrawOccurs when an XRControl object is drawn or redrawn in a report’s Print Preview. Inherited from XRControl.
EvaluateBindingOccurs after a data-bound XRControl object obtains data from its data source. Inherited from XRControl.
HtmlItemCreatedOccurs when a new item used for a Web representation of the control is created. Inherited from XRControl.
LocationChangedOccurs when the value of the XRControl.LocationF property is changed. Inherited from XRControl.
ParentChangedOccurs when the XRControl instance’s parent is changed. Inherited from XRControl.
PieSeriesPointExplodedFires when a pie slice, representing a series point, is moved to or from the pie center.
PivotChartingCustomizeLegendOccurs before automatic settings are applied to the legend‘s layout properties.
PivotChartingCustomizeResolveOverlappingModeOccurs before an automatic setting is applied to the overlap resolving mode of series labels.
PivotChartingCustomizeXAxisLabelsOccurs after automatic layout settings are applied to the X-axis’ labels.
PivotGridSeriesExcludedOccurs after a chart has been bound to a Pivot Grid.
PivotGridSeriesPointsExcludedOccurs after a chart has been bound to a Pivot Grid.
PreviewClickOccurs 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.
PreviewDoubleClickOccurs 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.
PreviewMouseDownOccurs 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.
PreviewMouseMoveOccurs when the mouse cursor moves over the control during the report’s preview. Inherited from XRControl.
PreviewMouseUpOccurs 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.
PrintOnPageOccurs when the representation of a control is printed on the current page of the report. Inherited from XRControl.
SizeChangedOccurs when the value of the XRControl.SizeF property is changed. Inherited from XRControl.
SmallChartTextShowingOccurs when the size of the control is not sufficient to display a readable chart.
TextChangedThis event is not available for the XRChart class.

See Also

XRChart Class

DevExpress.XtraReports.UI Namespace