View attributes LrView edit view properties
These properties are used by controls with editable text:
edit_field
, combo_box
, and password_field
.Summary
Alignment of text in frame.
True to auto-complete as the user types, using the
completion
table or function.A table of strings to use for completion.
True to validate the value as the user is typing.
For numeric edit fields, increment the value by this amount if Shift is not down.
For numeric edit fields, increment the value by this amount if Shift is held down.
For numeric edit fields, the maximum value allowed.
For numeric edit fields, the minimum value allowed.
For numeric edit fields, the number of decimal places to display.
A function called to validate the value.
The display text.
Properties
- alignment : (Read-Only)
-
Alignment of text in frame. Values are 'left', 'center', 'right'. (string, default: 'left')
First supported in version 1.3 of the Lightroom SDK.
- auto_completion : (Read-Only)
-
True to auto-complete as the user types, using the
completion
table or function. (Boolean, default: false) - completion : (Read-Only)
-
A table of strings to use for completion. (table, default: nil)
First supported in version 1.3 of the Lightroom SDK.
- immediate : (Read-Only)
-
True to validate the value as the user is typing. The validate function is called for every change, but the new value returned by the validate function does not replace the text the user is typing until the field loses the input focus. When false, the value is committed when the control loses the input focus. In Windows, this happens when the user types Enter or clicks outside the control. In Mac OS, it happens only when the user types Enter; clicking outside the control does not cause it to lose focus and commit. (Boolean, default: false)
First supported in version 1.3 of the Lightroom SDK.
- increment : (Read-Only)
-
For numeric edit fields, increment the value by this amount if Shift is not down. If the precision is 0 then the default is 1, otherwise the default is 0.1. (number, default: 1 or 0.1)
First supported in version 1.3 of the Lightroom SDK.
- large_increment : (Read-Only)
-
For numeric edit fields, increment the value by this amount if Shift is held down. If the precision is 0 then the default is 10, otherwise the default is 1. (number, default: 10 or 1)
First supported in version 1.3 of the Lightroom SDK.
- max : (Read-Only)
-
For numeric edit fields, the maximum value allowed. (number, default: nil)
First supported in version 1.3 of the Lightroom SDK.
- min : (Read-Only)
-
For numeric edit fields, the minimum value allowed. (number, default: nil)
First supported in version 1.3 of the Lightroom SDK.
- precision : (Read-Only)
-
For numeric edit fields, the number of decimal places to display. (number, default: 2)
First supported in version 1.3 of the Lightroom SDK.
- validate : (Read-Only)
-
A function called to validate the value. (function, default: nil) The function takes this form:
First supported in version 1.3 of the Lightroom SDK.
myValidate( view, value )
Returns three values:- result (Boolean) True if value was valid.
- value (any) The new value.
- message (string) If result is false, an error message.
- value : (Read-Only)
-
The display text. (any, default: nil)
First supported in version 1.3 of the Lightroom SDK.