IDatabaseWindowOptions¶
- class IDatabaseWindowOptions¶
Bases:
ImpactCOMWrapperBase- Description:
Advanced options used when displaying database windows
- Remarks:
Use IGUI.create_database_window_options to create the object. Introduced in Impact 11.0.0.27.
Wraps a COM object or another wrapper instance. Accepts: - A valid impact_object - An existing impact_com_wrapper_base-derived instance
- property child_column_name¶
Gets child_column_name.
- Description:
An optional child column name.
- Returns:
The value of child_column_name.
- Return type:
child_column_name (str)
- property drawing¶
Gets Drawing.
- Description:
A specific drawing to open the DBW on.
- property enforce_all_required_columns¶
Gets enforce_all_required_columns.
- Description:
Determines whether required columns must be entered (or not required until the drawing is saved).
- Returns:
The value of enforce_all_required_columns.
- Return type:
enforce_all_required_columns (bool)
- property layer¶
Gets Layer.
- Description:
A specific layer to open the DBW on, Drawing must be set first.
- property operation¶
Gets Operation.
- Description:
The operation to perform using the DBW.
- Remarks:
Only applies when displaying a DBW for external data. Supported operations are None, scroll_to_primary_key, Search, Add, Copy, Change, Delete, and delete_all.
- Returns:
The value of Operation.
- Return type:
- property parent_column_name¶
Gets parent_column_name.
- Description:
An optional parent column name.
- Returns:
The value of parent_column_name.
- Return type:
parent_column_name (str)
- property parent_key_value¶
Gets parent_key_value.
- Description:
An optional parent key value (either an integer or string).
- Returns:
The value of parent_key_value.
- Return type:
parent_key_value (any)
- property parent_table_name¶
Gets parent_table_name.
- Description:
An optional parent table name when you want to display records for a specific parent/child relationship.
- Remarks:
Only applies when displaying a DBW for external data. A parent_key_value and child_column_name must also be specified.
- Returns:
The value of parent_table_name.
- Return type:
parent_table_name (str)
- property primary_key¶
Gets primary_key.
- Description:
A specific primary key to perform the Operation on.
- Remarks:
Only applies when displaying a DBW for external data. Can also return a primary key if the operation is dwoScrollToPrimaryKey or dwoAdd.
- Returns:
The value of primary_key.
- Return type:
primary_key (int)
- property read_only¶
Gets read_only.
- Description:
Sets the DBW to be read only. Only applies when displaying a DBW for internal data.
- Returns:
The value of read_only.
- Return type:
read_only (bool)
- property window_title¶
Gets window_title.
- Description:
An optional window title to override that stored in the DBW.
- Returns:
The value of window_title.
- Return type:
window_title (str)