[]
        
(Showing Draft Content)

C1.Win.FlexPivot.FlexPivotPage

FlexPivotPage Class

Provides a complete user interface for FlexPivot applications.

Namespace: C1.Win.FlexPivot
Assembly: C1.Win.FlexPivot.8.dll
Syntax
[ToolboxBitmap(typeof(FlexPivotPage), "FlexPivotPage.png")]
[ComplexBindingProperties("DataSource", "DataMember")]
[Docking(DockingBehavior.AutoDock)]
public class FlexPivotPage : C1BasePanel, IDropTarget, ISynchronizeInvoke, IWin32Window, IBindableComponent, IComponent, IDisposable, IContainerControl, ISupportInitialize
Remarks

The control contains a C1FlexPivotPanel on the left and a tabbed content area on the right.

The C1FlexPivotPanel allows users to select and customize the fields that should be included in the Olap analysis.

The tabbed content area contains three pages: a C1FlexPivotGrid and a FlexPivotChart that show the Olap analysis, and a plain grid that shows the raw data.

The control also provides a customizable C1.Win.Command.C1ToolBar control with commonly used commands.

Constructors

Name Description
FlexPivotPage()

Initializes a new instance of a FlexPivotPage.

Properties

Name Description
ChartTotals

Gets or sets a value that determines whether the FlexPivotChart should display only totals.

ChartType

Gets or sets the type of chart to create.

CommandOpen

Gets the C1.Win.Command.C1Command used to open FlexPivot view files.

CommandSave

Gets the C1.Win.Command.C1Command used to save FlexPivot view files.

DataMember

Gets or sets the specific list in a DataSource object to be analyzed.

DataSource

Gets or sets the object that contains the data to be analyzed.

Document

Gets the C1FlexPivotPrintDocument used to render the current view.

FlexPivotChart

Gets the FlexPivotChart used to display the FlexPivot results.

FlexPivotEngine

Gets the C1FlexPivotEngine contained on the page.

FlexPivotGrid

Gets the C1FlexPivotGrid used to display the FlexPivot results.

FlexPivotPanel

Gets the C1FlexPivotPanel docked to the left of the page.

LabelSelection

Gets the ToolStripStatusLabel that appears on the right of the status strip docked to the bottom of the page.

LabelStatus

Gets the ToolStripStatusLabel that appears on the left of the status strip docked to the bottom of the page.

MenuChart

Gets the C1.Win.Command.C1CommandMenu used to control chart options.

MenuGrid

Gets the C1.Win.Command.C1CommandMenu used to control grid options.

MenuReport

Gets the C1.Win.Command.C1CommandMenu used to control report options.

Palette

Gets or sets the color scheme used for the data series.

PivotEngine

Gets the C1PivotEngine contained on the page.

RawDataGrid

Gets the C1.Win.FlexGrid used to display the raw data.

RawGridLimit

Gets or sets maximum raw data rows to show when connected to C1 DataEngine.

ShortcutsEnabled

Gets or sets a value that determines whether the page should automatically handle shortcut keys (e.g. Ctrl+S to save a view, Ctrl+O to open a view, Ctrl+Z to undo, Ctrl+Y to redo).

ShowDetailOnRightClick

Gets or sets a value that determines whether right-clicking the FlexPivot grid should cause the control to display the raw records represented by the cell clicked.

ShowGridLines

Gets or sets whether the chart should include gridlines along the X axis.

ShowLegend

Gets or sets whether the chart should include a legend.

ShowRawData

Gets or sets a value that determines whether the page should include a tab showing the raw data.

ShowSelectionStatus

Gets or sets a value that determines whether the control should automatically set the content of the LabelSelection to show the sum of the selected cells when the user makes selections on the grids.

ShowTitle

Gets or sets whether the chart should include a title.

ShowTotalsColumns

Gets or sets a value that determines whether the FlexPivot output table should include columns containing subtotals or grand totals.

ShowTotalsForColumns

Gets or sets a value that determines whether the FlexPivot output table should include columns containing subtotals or grand totals.

ShowTotalsForRows

Gets or sets a value that determines whether the FlexPivot output table should include rows containing subtotals or grand totals.

ShowTotalsRows

Gets or sets a value that determines whether the FlexPivot output table should include rows containing subtotals or grand totals.

ShowUndoRedo

Gets or sets a value that determines whether the toolbar should include undo/redo buttons.

ShowZeros

Gets or sets a value that determines whether the FlexPivot output table should use zeros to indicate missing values or leave the cells empty.

Stacked

Gets or sets a value that determines whether the series should be stacked or placed side-by-side.

TabControl

Gets the TabControl where the FlexPivotGrid and FlexPivotChart controls appear.

ToolBar

Gets the C1.Win.Command.C1ToolBar docked to the top of the page.

TotalsBeforeData

Gets or sets a value that determines whether row and column totals should be displayed before or after regular data rows and columns. If this value is set to true, total rows appear above data rows and total columns appear on the left of regular data columns.

ViewDefinition

Gets or sets the FlexPivot view definition as an Xml string.

Methods

Name Description
BeginInit()
Dispose(bool)

Clean up any resources being used.

EndInit()
OnDataEngineConnectionChanged(EventArgs)

Raises the DataEngineConnectionChanged event.

OnDataSourceChanged(EventArgs)

Raises the DataSourceChanged event.

OnFontChanged(EventArgs)

Overriden to update toolbar and status bar size and font.

OnLoadedFields(EventArgs)

Raises the LoadedFields event.

OnUpdated(EventArgs)

Raises the Updated event.

OnUpdating(EventArgs)

Raises the Updating event.

OnViewDefinitionChanged(EventArgs)

Raises the ViewDefinitionChanged event.

ProcessCmdKey(ref Message, Keys)

Overridden to process shortcut keys.

ReadXml(string)

Reads the control settings from a file.

ReadXml(XmlReader)

Reads the control settings from an System.Xml.XmlReader.

WriteXml(string)

Saves the control settings into an Xml file.

WriteXml(XmlWriter)

Saves the control settings into an System.Xml.XmlWriter.

Events

Name Description
DataEngineConnectionChanged

Occurs when a DataEngine table is connected.

DataSourceChanged

Occurs when the data source changes.

LoadedFields

Occurs after the FlexPivotPanel finishes loading the fields for the current DataSource.

Updated

Occurs after the FlexPivotPanel finishes the FlexPivot analysis.

Updating

Occurs before the FlexPivotPanel starts updating the output FlexPivot table.

ViewDefinitionChanged

Occurs when the view definition changes, before the output table is updated.