The requested page is not available for the requested platform. You are viewing the content for Default platform.

XRPivotGrid Members

Displays multi-dimensional data in reports.

Constructors

Name Description
XRPivotGrid()

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

Properties

Name Description
ActualHeight

Gets the XRPivotGrid's rendered height (measured in report units).

ActualWidth

Gets the XRPivotGrid's rendered width (measured in report units).

AnchorHorizontal

Specifies the horizontal anchoring style of a report control.

(Inherited from XRControl)
AnchorVertical

Specifies the vertical anchoring style of a report control.

(Inherited from XRControl)
Appearance

Provides access to the properties that control the appearance of the pivot grid's elements.

AppearancePrint

For internal use.

BackColor

For internal use.

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

For internal use.

BorderDashStyle

For internal use.

BorderWidth

For internal use.

Borders

For internal use.

Bottom

For internal use.

(Inherited from XRControl)
BottomF

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

(Inherited from XRControl)
Bounds

For internal use.

(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

For internal use.

CanHaveChildren

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

(Inherited from XRControl)
CanPublish

For internal use.

CanRaiseEvents Gets a value indicating whether the component can raise an event.
(Inherited from Component)
CanShrink

For internal use.

CellStyleName

Gets or sets the name of the style assigned to the XRPivotGridStyles.CellStyle property.

ColumnCount

Gets the number of columns in the XRPivotGrid.

Container Gets the IContainer that contains the Component.
(Inherited from Component)
ControlType

For internal use.

(Inherited from XRControl)
Controls

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

(Inherited from XRControl)
CustomTotalCellStyleName

Gets or sets the name of the style assigned to the XRPivotGridStyles.CustomTotalCellStyle property.

DataAdapter

Gets or sets the data adapter used to populate the pivot grid's data source.

DataBindings

For internal use.

DataMember

Specifies the data source member which supplies data to the Pivot Grid.

DataSource

Gets or sets the pivot grid control's data source. If it's empty, then the report's data source will be used.

DesignMode Gets a value that indicates whether the Component is currently in design mode.
(Inherited from Component)
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 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)
FieldHeaderStyleName

Gets or sets the name of the style assigned to the XRPivotGridStyles.FieldHeaderStyle property.

FieldValueGrandTotalStyleName

Gets or sets the name of the style assigned to the XRPivotGridStyles.FieldValueGrandTotalStyle property.

FieldValueStyleName

Gets or sets the name of the style assigned to the XRPivotGridStyles.FieldValueStyle property.

FieldValueTotalStyleName

Gets or sets the name of the style assigned to the XRPivotGridStyles.FieldValueTotalStyle property.

Fields

Provides access to a pivot grid's field collection.

FilterSeparatorStyleName

Gets or sets the name of the style assigned to the XRPivotGridStyles.FilterSeparatorStyle property.

Font

For internal use.

ForeColor

For internal use.

For internal use.

(Inherited from XRControl)
FormattingRules

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

(Inherited from XRControl)
GrandTotalCellStyleName

Gets or sets the name of the style assigned to the XRPivotGridStyles.GrandTotalCellStyle property.

Groups

For internal use.

HasChildren

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

(Inherited from XRControl)
HeaderGroupLineStyleName

Gets or sets the name of the style assigned to the XRPivotGridStyles.HeaderGroupLineStyle property.

Height

For internal use.

(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)
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

Specifies whether a control can be split across pages.

(Inherited from XRControl)
Left

For internal use.

(Inherited from XRControl)
LeftF

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

(Inherited from XRControl)
LinesStyleName

Gets or sets the name of the style assigned to the XRPivotGridStyles.LinesStyle property.

Location

For internal use.

(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)
Name

Gets or sets a name of the control.

(Inherited from XRControl)
NavigateUrl

For internal use.

NullValueText

For internal use.

(Inherited from XRControl)
OLAPConnectionString

Specifies a connection string to a cube in an MS Analysis Services database.

OLAPDataProvider

Specifies an OLAP data provider.

OddStyleName

For internal use.

OptionsBehavior

For internal use.

OptionsChartDataSource

Provides access to the options controlling the display of the Pivot Grid's data in a Chart.

OptionsCustomization

For internal use.

OptionsData

Provides access to the pivot grid's data specific options.

OptionsDataField

Provides access to the options which control the presentation of the data fields in the Pivot Grid.

OptionsLayout

For internal use.

OptionsOLAP

For internal use.

OptionsPrint

Provides access to the pivot grid's print options.

OptionsView

Provides access to the pivot grid's display options.

Padding

For internal use.

Parent

Specifies the parent object that contains the current control.

(Inherited from XRControl)
ParentStyleUsing

For internal use.

(Inherited from XRControl)
Prefilter

Provides access to the Prefilter settings that enable filtering the incoming data.

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)
Right

For internal use.

(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 content within the Pivot Grid's cells.

RootReport

Provides access to the report to which the control belongs.

(Inherited from XRControl)
RowCount

Gets the number of rows in the XRPivotGrid.

Scripts

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

Site Gets or sets the ISite of the Component.
(Inherited from Component)
Size

For internal use.

(Inherited from XRControl)
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)
SnapLinePadding

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

(Inherited from XRControl)
StyleName

For internal use.

StylePriority

For internal use.

Styles

Provides access to the style settings that control the appearance of the Pivot Grid.

Tag

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

(Inherited from XRControl)
Target

For internal use.

Text

For internal use.

TextAlignment

For internal use.

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

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

(Inherited from XRControl)
TotalCellStyleName

Gets or sets the name of the style assigned to the XRPivotGridStyles.TotalCellStyle property.

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

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

(Inherited from XRControl)
WordWrap

For internal use.

XlsxFormatString

For internal use.

Methods

Name Description
AllControls<T>()

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

(Inherited from XRControl)
BestFit()

Resizes the columns which correspond to the data fields and row fields to the minimum width required to completely display the column's contents.

BestFit(XRPivotGridField)

Resizes the columns which correspond to the specified field to the minimum width required to completely display the column's contents.

BringToFront()

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

(Inherited from XRControl)
CollapseAll()

Collapses all the columns and rows in the pivot grid.

CollapseAllColumns()

Collapses all the columns in the pivot grid.

CollapseAllRows()

Collapses all the rows in the pivot grid.

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)
ExpandAll()

Expands all the columns and rows in the pivot grid.

ExpandAllColumns()

Expands all the columns in the pivot grid.

ExpandAllRows()

Expands all the rows in the pivot grid.

FindControl(String, Boolean)

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

(Inherited from XRControl)
GetCellInfo(Int32, Int32)

Returns an object that contains information on the specified cell.

GetCellValue(Int32, Int32)

Returns a value displayed in the specified cell.

GetCellValue(Object[], Object[])

Retrieves a cell value, identified by the specified column and row field values.

GetCellValue(Object[], Object[], XRPivotGridField)

Retrieves a cell value, identified by the specified data field, column and row field values.

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)
GetEffectiveBorderWidth()

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

(Inherited from XRControl)
GetEffectiveBorders()

Returns the borders settings actually used as the control's borders 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)
GetFieldByArea(PivotArea, Int32)

Returns a field at the specified visual position in the specified area.

GetFieldValue(PivotGridFieldBase, Int32)

Returns the specified field value.

GetFieldValueType(Boolean, Int32)

Gets the type of a field value in the column or row area.

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) 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)
IsObjectCollapsed(Boolean, Int32, Int32)

Returns a value indicating whether or not the specified column field value or row field value is collapsed.

IsObjectCollapsed(XRPivotGridField, Int32)

Returns a value indicating whether or not the specified column field value or row field value is collapsed.

MemberwiseClone() Creates a shallow copy of the current Object.
(Inherited from Object)
MemberwiseClone(Boolean) 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)
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)
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)
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)
RestoreLayoutCore(XtraSerializer, Object, OptionsLayoutBase)

De-serializes the core functionality of the XRPivotGrid.

RestoreLayoutFromStream(Stream)

Restores a pivot grid's layout from the specified stream.

RestoreLayoutFromStream(Stream, OptionsLayoutBase)

Restores a pivot grid's layout from the specified stream, using the specified settings.

ResumeLayout()

Resumes normal layout logic for the control.

(Inherited from XRControl)
RetrieveFields()

Creates XRPivotGridField objects for all the fields in the XRPivotGrid's bound data source.

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(TextRenderingHint)

Returns a control's graphical representation 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)
XtraFindFieldsItem(XtraItemEventArgs)

For internal use.

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)
CustomCellDisplayText

Enables custom display text to be provided for the cells displayed within the Data Area.

CustomCellValue

Allows you to replace cell values with custom ones.

CustomChartDataSourceData

Occurs when a XRPivotGrid control prepares data to be displayed in a XRChart control.

CustomChartDataSourceRows

Occurs before the XRPivotGrid control passes its data to a bound XRChart control.

CustomColumnWidth

Enables you to specify a custom column width (e.g., to hide some columns based on specific criteria).

CustomFieldSort

Provides the capability to sort data using custom rules.

CustomFieldValueCells

Allows you to customize field value cells of XRPivotGrid.

CustomGroupInterval

Allows you to custom group values of column and row fields.

CustomRowHeight

Enables you to specify a custom row height (e.g., to hide some rows based on specific criteria).

CustomServerModeSort

Provides the capability to sort data using custom rules in OLAP and server mode.

CustomSummary

Enables summary values to be calculated manually.

CustomUnboundFieldData

Enables data to be provided for unbound fields.

Disposed Occurs when the component is disposed by a call to the Dispose() method.
(Inherited from Component)
Draw

This event is not available for the XRPivotGrid class.

EvaluateBinding

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

(Inherited from XRControl)
FieldValueDisplayText

Enables the display text of individual column and row headers and filter dropdown items to be customized.

HtmlItemCreated

This event is not available for the XRPivotGrid class.

LocationChanged

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

(Inherited from XRControl)
ParentChanged

Occurs when the XRControl instance's parent is changed.

(Inherited from XRControl)
PrefilterCriteriaChanged

Fires when the Prefilter's criteria are changed.

PreviewClick

This event is not available for the XRPivotGrid class.

PreviewDoubleClick

This event is not available for the XRPivotGrid class.

PreviewMouseDown

This event is not available for the XRPivotGrid class.

PreviewMouseMove

This event is not available for the XRPivotGrid class.

PreviewMouseUp

This event is not available for the XRPivotGrid class.

PrintCell

Enables you to render a different content for individual data cells.

PrintFieldValue

Enables you to render a different content for individual field values.

PrintHeader

Enables you to render a different content for individual field headers.

PrintOnPage

This event is not available for the XRPivotGrid class.

SizeChanged

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

(Inherited from XRControl)
TextChanged

This event is not available for the XRPivotGrid class.

See Also