IDatabaseTableRow¶
- class IDatabaseTableRow¶
Bases:
ImpactCOMWrapperBase- Description:
Represents a table row in the parent table object.
- Remarks:
This is similar to the IDatabaseValues interface providing access to data in each row of the parent table 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 bytes_as_variant¶
Gets bytes_as_variant.
- Description:
Determines whether binary data from BLOB fields is returned as a variant array of bytes or a variant array of variants.
- Returns:
The value of bytes_as_variant.
- Return type:
bytes_as_variant (bool)
- property field_count¶
Gets field_count.
- Description:
Determines the number of fields in the row.
- Returns:
The value of field_count.
- Return type:
field_count (int)
- property field_name¶
Gets field_name.
- Description:
Determines the name of a field by index.
- Returns:
The value of field_name.
- Return type:
field_name (str)
- property field_prompt¶
Gets field_prompt.
- Description:
Determines the prompt of a field by index.
- Returns:
The value of field_prompt.
- Return type:
field_prompt (str)
- property guid¶
Gets GUID.
- Description:
Returns a unique identifier for each table row.
- Remarks:
This property is not persisted and is regenerated each time the underlying object is created.
- Returns:
The value of GUID.
- Return type:
guid (str)
- property needs_updating¶
Gets needs_updating.
- Description:
Determines if the row needs updating (Status is not dtrsUnmodified).
- Returns:
The value of needs_updating.
- Return type:
needs_updating (bool)
- property status¶
Gets Status.
- Description:
Determines the status of the row.
- Remarks:
Once any changes have been committed using the do_update method then the Status will always be dtrsUnmodified.
- Returns:
The value of Status.
- Return type:
- property unit_settings¶
Gets unit_settings.
- Description:
Set a specific IUnitSettings to control reading and writing values.
- Returns:
The value of unit_settings.
- Return type:
- property values_as_variants¶
Gets values_as_variants.
- Description:
Determines whether values are returned as strings or native variant types.
- Returns:
The value of values_as_variants.
- Return type:
values_as_variants (bool)
- exists(field_name)¶
- Description:
Determines if a value exists for the specified field.
- Parameters:
field_name (str) – Field name
- load(field_name)¶
- Description:
Reads a value from the row.
- Parameters:
field_name (str) – Field name
- load_default(field_name, default)¶
- Description:
Reads a value from the row with a specific default value if the row doesn’t contain a value.
- Parameters:
field_name (str) – Field name
default (any) – Default value
- prompt(field_name)¶
- Description:
Gets the prompt for the field name specified.
- Parameters:
field_name (str) – Field name
- save(field_name, field_value)¶
- Description:
Writes a value to the row.
- Parameters:
field_name (str) – Field name
field_value (any) – Value