ComponentOne FlexPivot for WinForms
C1.PivotEngine Assembly / C1.PivotEngine Namespace / C1PivotEngine Class
Properties Methods Events


In This Topic
    C1PivotEngine Class Members
    In This Topic

    The following tables list the members exposed by C1PivotEngine.

    Public Constructors
     NameDescription
    Public ConstructorC1PivotEngine ConstructorInitializes a new instance of a C1PivotEngine.  
    Top
    Public Properties
     NameDescription
    Public PropertyColumnFieldsGets a list of PivotField objects that define the fields shown as columns in the output table.  
    Public PropertyDataSourceGets or sets the object that contains data to be analyzed.  
    Public PropertyFieldsGets the list of PivotField objects exposed by the data source.  
    Public PropertyFilteredItemCountGets the number of elements that are represented in the current view.  
    Public PropertyFilterFieldsGets a list of PivotField objects that define the fields used as filters for the output table.  
    Public PropertyIsViewDefinedGets a value that determines whether a PivotEngine view is currently defined.  
    Public PropertyItemCountGets the number of elements that in the data source.  
    Public PropertyPivotDefaultViewGets the default System.ComponentModel.IBindingList that exposes the data in the PivotTable.  
    Public PropertyPivotTableGets the System.Data.DataTable that contains the output of the PivotEngine analysis.  
    Public PropertyRowFieldsGets a list of PivotField objects that define the fields shown as rows in the output table.  
    Public PropertyShowKeyColumnsGets or sets a value that determines whether the PivotEngine output table should include columns containing the row keys.  
    Public PropertyShowTotalsColumnsGets or sets a value that determines whether the PivotEngine output table should include columns containing subtotals or grand totals.  
    Public PropertyShowTotalsRowsGets or sets a value that determines whether the PivotEngine output table should include rows containing subtotals or grand totals.  
    Public PropertyShowZerosGets or sets a value that determines whether the PivotEngine output table should use zeros to indicate missing values.  
    Public PropertySortOnServerGets or sets a value that indicates whether the summary data received from the server is already sorted. If this property is set to true, the PivotEngine will not sort the data it receives from the server.  
    Public PropertyTotalsBeforeDataGets 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.  
    Public PropertyValueFieldGets the first PivotField in the ValueFields collection, or null if the collection is empty.  
    Public PropertyValueFieldsGets a list of PivotField objects that define the fields summarized in the cells of the output table.  
    Public PropertyViewDefinitionGets or sets the PivotEngine view definition as an XML string.  
    Public PropertyWorkspaceGets or sets the DataEngine workspace.  
    Top
    Public Methods
     NameDescription
    Public MethodBeginUpdateSuspend automatic updates to the output table while defining the PivotEngine view.  
    Public MethodCancelUpdateRequests cancellation of a pending request operation.  
    Public MethodConnectDataEngineConnect to a C1.DataEngine table.  
    Public MethodDisposeClean up any resources being used.  
    Public Methodstatic (Shared in Visual Basic)DisposeWorkspaceDisposes the specified workspace and cancel all related tasks  
    Public MethodEndUpdateRestore automatic updates to the output table after the PivotEngine view has been defined.  
    Public Methodstatic (Shared in Visual Basic)ExecOverloaded. Server-side asynchronous execution of a view returning aggregated results to the caller client.  
    Public MethodGetDetailOverloaded. Gets a list of objects in the raw data source that define the content of a specific cell in the output table exposed by the PivotTable property.  
    Public Methodstatic (Shared in Visual Basic)GetDetailsOverloaded. Makes source data rows used in obtaining a given aggregated value accessible to the server's clients.  
    Public Methodstatic (Shared in Visual Basic)GetMetadataOverloaded. Lists fields with their types and provides other metadata for a DataEngine table.  
    Public MethodGetPivotKeyOverloaded. Gets the PivotKey associated with a System.Data.DataColumn on a PivotEngine table.  
    Public MethodGetRawDataOverloaded. Makes the entire raw source data collection accessible to the server's clients.  
    Public Methodstatic (Shared in Visual Basic)GetUniqueValuesOverloaded. Lists unique values of a field for the server's clients.  
    Public MethodGetViewTitleOverloaded. Gets a string with a title describing the current view.  
    Public MethodReadXmlOverloaded. Reads a PivotEngine view definition from an System.Xml.XmlReader.  
    Public MethodTransposeFieldsTransposes the fields in the current view so rows become columns and columns become rows.  
    Public MethodUpdateCauses the PivotEngine to rebuild the output table exposed by the PivotTable property.  
    Public MethodWriteXmlOverloaded. Saves the current PivotEngine view definition into an System.Xml.XmlWriter.  
    Top
    Protected Methods
     NameDescription
    Protected MethodOnCancelUpdating  
    Protected MethodOnDataEngineWorkspaceChanged  
    Protected MethodOnLoadedFieldsRaises the LoadedFields event.  
    Protected MethodOnStartUpdating  
    Protected MethodOnUpdatedRaises the Updated event.  
    Protected MethodOnUpdateErrorRaises the UpdateError event.  
    Protected MethodOnUpdatingRaises the Updating event.  
    Top
    Public Events
     NameDescription
    Public EventCancelUpdatingOccurs when calculation is cancelled.  
    Public EventLoadedFieldsFires after the PivotEngine finishes loading the fields for the current DataSource.  
    Public EventStartUpdatingOccurs when calculation starts.  
    Public EventUpdateCompletedFires after the update of the C1PivotEngine is finished.  
    Public EventUpdatedFires after the PivotEngine finishes its analysis and the output PivotTable is ready.  
    Public EventUpdateErrorFires when an error occurs while updating.  
    Public EventUpdateProgressChangedFires when the update progress of the C1PivotEngine is changed.  
    Public EventUpdatingFires before the PivotEngine starts updating the output PivotTable.  
    Top
    Public Operators
    public Operator Implicit Type Conversion  
    Top
    See Also

    Reference

    C1PivotEngine Class
    C1.PivotEngine Namespace