PropertyDef

View as Markdown

A property definition: a property that objects can have, with its data type and, for lookup properties, the value list or object type its values come from.

Full nameMFiles.PropertyDef
Proto filemfiles/structs.proto

Fields

FieldTypeNumberDescription
idint321The property definition ID. Built-in property definitions (0 Name or title, 20 Created, 100 Class, ...) have the same ID in every vault. IDs 1-19 are never used by real property definitions.
namestring2The name of the property.
tooltipstring3The tip text of this property.
data_typeDatatype4The data type of the values. Lookup properties use DATATYPE_LOOKUP (one item) or DATATYPE_MULTI_SELECT_LOOKUP (several items).
content_typeContentType5Content type (sub-datatype).Values: CONTENT_TYPE_GENERIC (0), CONTENT_TYPE_EMAIL_ADDRESS (1), CONTENT_TYPE_URL (2), CONTENT_TYPE_RTF (3), CONTENT_TYPE_HTML (4).
is_based_on_value_listbool7True for lookup properties; value_list then names the list. Test this flag, not value_list != 0: 0 is a valid list ID (the Document object type).
enable_automatic_permissionsbool8True to allow automatic permissions via this property def.
is_conflict_referencebool9True if this is the conflict property of the object type in value_list.
disallow_as_grouping_levelbool10True to disallow using this property def as a grouping level in views.
value_listint3211With is_based_on_value_list, the ID of the value list or object type whose items are the property's values.
value_list_item_filterrepeated SearchCondition12A static filter on the items of value_list. The server applies it when this property is passed as filtering_property_def or LookupItemRequest.property_def; such conditions cannot be sent in search_conditions directly.
update_typeUpdateType13The update behaviour of the property.Values: UPDATE_TYPE_NORMAL (0), UPDATE_TYPE_SET_BY_SERVER (1), UPDATE_TYPE_SET_BY_CLIENT_CODE (2).
automatic_value_typeAutomaticValueType14Defines the type of the automatic value of this field, if any.Values: AUTOMATIC_VALUE_TYPE_NONE (0), AUTOMATIC_VALUE_TYPE_CALCULATE_WITH_TEMPLATE (1), AUTOMATIC_VALUE_TYPE_CALCULATED_WITH_CODE (2), AUTOMATIC_VALUE_TYPE_FIXED_VALUE_WITH_INCREMENT (3), AUTOMATIC_VALUE_TYPE_FIXED_VALUE_WITH_CODE (4).
default_valueTypedValue15If set, specifies a fixed default value for this property.
iconBytes16If set, contains an icon in .ICO format (contains multiple sizes and color depths).
is_predefinedbool17True if this is a predefined PropertyDef. Predefined PropertyDefs cannot be deleted and modifying them is restricted.
allow_for_all_object_typesbool18True if this property definition can be used with all object types.
is_ownerbool19True if this is the owner property of the object type in value_list.
is_defaultbool20True if this is the default property of the object type in value_list (ValueList.default_property_def).
owner_property_def_infoOwnerPropertyDef21For a lookup property, the property whose value limits this property's values. For example, Workflow State (39) is limited by Workflow (38). A property_def of -106 means that the owner property is determined automatically.
object_typeint3222If allow_for_all_object_types is false, the object type whose objects use this property; otherwise ignored.
aclAccessControlList23If set, specifies the ACL that defines the visibility and editability of this property in objects.
property_def_permissionsPropertyDefPermissionsForClient32What the caller may do with values of this property: see them and edit them. Set when the property definition has permissions.
value_list_sorting_typeVLSortingType24The sorting type of value list items.Values: VLSORTING_TYPE_BY_DISPLAY_NAME (0), VLSORTING_TYPE_BY_EXTERNAL_ID (1).
value_list_sort_ascendingbool25True to sort in ascending order, false to sort in descending order.
validation_typeValidationType26How values are validated; validation_string holds the rule.Values: VALIDATION_TYPE_NONE (0), VALIDATION_TYPE_REGEX (1), VALIDATION_TYPE_CODE (2).
validation_stringstring27The validation rule; its meaning depends on validation_type.
formatting_typeFormattingType28How values are formatted; formatting_string holds the format.Values: FORMATTING_TYPE_NONE (0).
formatting_stringstring29The format; its meaning depends on formatting_type.
guidstring30The GUID of the property definition, with braces.
optionsPROPERTYDEFFLAGS31Flags such as can_use_in_search. See PROPERTYDEFFLAGS.

Used by methods

Used in fields