IFindItemsOptions¶
- class IFindItemsOptions¶
Bases:
ImpactCOMWrapperBase- Summary:
A parameters object defining the find operation that will be performed by IDatabase.find_items or IDatabase.find_layers.
- Remarks:
Introduced in Impact 6.1.0.43
Wraps a COM object or another wrapper instance. Accepts: - A valid impact_object - An existing impact_com_wrapper_base-derived instance
- property drawing_type¶
Gets drawing_type.
- Summary:
The type of drawings to find.
- Remarks:
Ignored when finding layers.
- Returns:
The value of drawing_type.
- Return type:
- property include_added_layers¶
Gets include_added_layers.
- Summary:
Indicates if layers added to the project will be included in the reults when searching for layers.
- Returns:
The value of include_added_layers.
- Return type:
include_added_layers (bool)
- property include_deleted_layers¶
Gets include_deleted_layers.
- Summary:
Indicates if layers deleted from the project will be included in the reults when searching for layers.
- Returns:
The value of include_deleted_layers.
- Return type:
include_deleted_layers (bool)
- property known_empty_set¶
Gets known_empty_set.
- Summary:
A flag indicating if the caller already knows that the search will return nothing.
- Remarks:
This will force find_items or find_layers to return an empty result set without doing any actual searching. Default = false.
- Returns:
The value of known_empty_set.
- Return type:
known_empty_set (bool)
- property layer_table_context¶
Gets layer_table_context.
- Summary:
When finding layers, the name of the layer type to find.
- Remarks:
Leave this blank when finding drawings. When finding general layers (ie of any type), use “LAYERS”. Otherwise, use the name of the specific layer type being found.
- Returns:
The value of layer_table_context.
- Return type:
layer_table_context (str)
- property max_records¶
Gets max_records.
- Summary:
The maximum number of records to return.
- Remarks:
The result set will be capped at this value.
- Returns:
The value of max_records.
- Return type:
max_records (int)
- property order_ascending¶
Gets order_ascending.
- Summary:
A flag that specifies if the reuslts should be in ascending or descending order.
- Remarks:
True = ascending; false = descending. The column(s) by which to sort are specified in the order_by property. Default = true.
- Returns:
The value of order_ascending.
- Return type:
order_ascending (bool)
- property order_by¶
Gets order_by.
- Summary:
Name(s) of column by which to order the result set.
- Remarks:
When searching for layers, the column names must be qualified with their table name. Column names must be separated by a comma (if more than one column specified).
- Returns:
The value of order_by.
- Return type:
order_by (str)
- property query_mts¶
Gets query_mts.
- Summary:
The database_query MTS object used to do the finding.
- Remarks:
If this is not NULL, the SQL property will be ignored.
- Returns:
The value of query_mts.
- Return type:
- property sql¶
Gets SQL.
- Summary:
Where clause of the SQL used to do the finding.
- Remarks:
If query_mts is not NULL, SQL will be ignored. When searching for layers, all referenced columns must be qualified with their table name.
- Returns:
The value of SQL.
- Return type:
sql (str)
- property sql_filter_conditions¶
Gets sql_filter_conditions.
- Summary:
A number of filter conditions to be applied.
- Remarks:
An array of ISQLFilterCondition objects. Introduced in Impact 7.0.0.34.
- Returns:
The value of sql_filter_conditions.
- Return type:
sql_filter_conditions (any)
- isNone()¶
Checks if the COM object is None. This is useful for determining if the wrapper has been initialized with a valid COM object.