IDatabaseColumn¶
- class IDatabaseColumn¶
Bases:
ImpactCOMWrapperBase- Summary:
Represents a column description in the table.
Wraps a COM object or another wrapper instance. Accepts: - A valid impact_object - An existing impact_com_wrapper_base-derived instance
- property allow_null¶
Gets allow_null.
- Summary:
Indicates if the column can contain null values.
- Returns:
The value of allow_null.
- Return type:
allow_null (bool)
- property ascending¶
Gets Ascending.
- Summary:
Indicates an ascending column index.
- Returns:
The value of Ascending.
- Return type:
ascending (bool)
- property case_sensitive¶
Gets case_sensitive.
- Summary:
Indicates a case sensitive column index.
- Returns:
The value of case_sensitive.
- Return type:
case_sensitive (bool)
- property has_units¶
Gets has_units.
- Summary:
Indicates whether the column has an associated Units property.
- Remarks:
This property can be used to determine if the column type supports Units. Returns true if the column type is dctDistance, dctArea, dctVolume, dctAngle, or dctWeight.
- Returns:
The value of has_units.
- Return type:
has_units (bool)
Gets Hidden.
- Summary:
Indicates whether the column is Hidden.
- Returns:
The value of Hidden.
- Return type:
hidden (bool)
- property index_name¶
Gets index_name.
- Summary:
The column index name.
- Returns:
The value of index_name.
- Return type:
index_name (str)
- property indexed¶
Gets Indexed.
- Summary:
Indicates if the column is indexed.
- Returns:
The value of Indexed.
- Return type:
indexed (bool)
- property is_blob¶
Gets is_blob.
- Summary:
Indicates if the column data is stored as a BLOB.
- Remarks:
Columns containing long data are stored in the database as blo_bs (Binary Large o_bjects). Returns true if the column Type is dctMemo or dctData.
- Returns:
The value of is_blob.
- Return type:
is_blob (bool)
- property length¶
Gets Length.
- Summary:
The column length.
- Remarks:
This property is only valid if the Type is dctCharacter.
- Returns:
The value of Length.
- Return type:
length (int)
- property name¶
Gets Name.
- Summary:
The column name.
- Returns:
The value of Name.
- Return type:
name (str)
- property private¶
Gets Private.
- Summary:
Indicates whether the column is Private.
- Returns:
The value of Private.
- Return type:
private (bool)
- property prompt¶
Gets Prompt.
- Summary:
The column prompt.
- Returns:
The value of Prompt.
- Return type:
prompt (str)
- property relationships¶
Gets Relationships.
- Summary:
Returns a collection of the table relationships defined for this column.
- Remarks:
Introduced in Impact 11.0.0.27
- Returns:
The value of Relationships.
- Return type:
- property type¶
Gets Type.
- Summary:
The column type.
- Returns:
The value of Type.
- Return type:
- property unique¶
Gets Unique.
- Summary:
Indicates a unique column index.
- Returns:
The value of Unique.
- Return type:
unique (bool)
- property units¶
Gets Units.
- Summary:
The column units.
- Remarks:
This property is only valid if has_units is true. Units will return -1 if has_units is false or the column is stored in the database as a character string. If the column Type is dctDistance, dctArea, or dctVolume then Units returns a value equivalent to ipDistanceFormat. If the column Type is dctAngle then Units returns a value equivalent to ipAngleFormat. If the column Type is dctWeight then Units returns a value equivalent to ipWeightFormat.
- Returns:
The value of Units.
- Return type:
units (int)
- isNone()¶
Checks if the COM object is None. This is useful for determining if the wrapper has been initialized with a valid COM object.
- prompt_translated(language_id, exact_language_match)¶
- Summary:
Returns the column’s prompt, translated into the specified language.
- Remarks:
For a more detailed explanation of the parameters, please see the notes for the IDatabase.master_setting_name_translated method. Introduced in Impact 11.0.0.112
- Parameters:
language_id (any) – A string or enum representing the language wanted.
exact_language_match (bool) – Specifies what to do if there is no translation for the specified language.