2.2.4.5 Column

Contents

Name

Column

Remark

The Column class provides methods and properties common to Origin worksheet columns. An Origin C Worksheet object has a collection of Column objects each of which in turn holds a Dataset. A Column object is primarily used for style related control of the data in the associated Dataset.

An Origin C Column object is a wrapper object that is a reference to an internal Origin column object. Wrapper objects do not actually exist in Origin and merely refer to the internal Origin object. Consequently, multiple Origin C wrapper objects can refer to the same internal Origin object.

The Column class is derived from the DataObject, DataObjectBase, and OriginObject classes from which it inherits methods and properties.

Hierarchy

Examples

EX1 

void Column_Ex1()
{
    Worksheet wks = Project.ActiveLayer();
    if(!wks)
        return;
    int ii = 1;
    foreach(Column cc in wks.Columns)
    {
        string strLabel;
        if(cc.GetLabel(strLabel) > 0)
            printf("Column(%d) has label = %s\n",ii++, strLabel);
    }
}

Header to Include

origin.h

Reference

Members

Name Brief Example
Attach the column object to a Worksheet column by worksheet name nad column number.
Default constructor for Column class.
Copy column format from source.
Enable/Disable the filter
Get storage information from SPC.
Get the comments in a column label.
Get indexes of conditional formatted rows
Return the custom date display string. Only valid for Date type columns.
Get the Dataset associated with a column as a vectorbase class reference.
Gets the display mode used for numbers in a column.
Get the digit value for numeric display mode.
Get all the unique text entries of the column value.
Gets the extended label by type of extended label.
Get data filter of one column.
Get the column format.
Get the column CategoricalMap.
Get the column internal data type.
Get the column justification.
Get the column label by reference.
Get the index of the column in the same worksheet that is farthest away. from this column and that is dependent on this column.
Get the long name of a column.
Get the begining row index for this column. Index values are 0 - offset.
Get the column short name.
Get the number of rows in a Column.
Get one parameter value.from column label.
Gets the Parameters in a column label.
Get the contents (from row nRow1 to nRow2) from a Column regardless of its data type.
Get the SubFormat used by a column.
Get the text width of a column.
Get the type designator of a column (X, Y, Z, YErr, XErr, L or disregard).
Get the units in a column label.
Get the ending row index for this column. Index values are 0 - offset.
Get the display width of a column in number of characters.
Return if the column is set as categorical.
Check if the column has even sampling and get the sampling information.
Gets the filter's enable status
Determine if a column is write protected.
Put (copy) the contents of a StringArray to a Column starting in row nRow1.
This function is use to reverse a range of rows within a column.
Reset data filter of one column.
Set the column as categorical.
Sets the comments in a column label.
To set the custom date display format. This action is same as setup Custom Date Formats in Tools : Options : Miscellaneous.
Sets the display mode used for numbers in a column.
Set the digit value for the numeric display mode.
Set the column sampling information.
Sets the extended label by type of extended label.
Add data filter to column.
Set variable to represent this column in filter command
Set the column format.
Set the column internal data type.
Set the column justification.
Set the column label.
Sets the long name of a column.
Set the begining row display index.
Set the number of rows in a Column.
Sets one parameter in a column label
Sets the Parameters in a column label.
Set the SubFormat used by a column.
Set the text width of the column.
Set the type designator of a column (X, Y, Z, YErr, XErr, L or disregard).
Set the units in a column label.
Set the ending row display index.
Set the display column width of a column in number of characters.