MetadataForm (Component)

Metadata forms are collections of site administrator-defined fields. After being bound to CommonSpot page-level objects--for example, templates, page categories, and document types--you can combine metadata forms to dynamically render pages based on criteria such as page location (which subsite), page template, page category, or any of the other classifications CommonSpot makes available. Use the data you collect through metadata forms to personalize or target content, dynamically determine layout, build dynamic indexes, or help find or access content. Metadata forms fields can be required, and they can have default and security values. Large forms can possess a tabbed interface that makes metadata fields easier to navigate.

Methods marked below with [L] may be logged at the site level (if transaction logging is licensed and enabled by the administrator)

Customization is not supported for this component.

Methods:

clone [L]	Creates a copy of a metadata form.
createStandardFilterStatement	Returns a string describing a 'standard' filter statement. A 'standard' statement is in the form {field} {operator} {value}, where the field is any metadata form field (besides a date, taxonomy, formatted text block, or author) and the value is a single item not a list of items. Note the returned string is an internal string format so only use this method to create the statement string.
deleteBinding [L]	Removes the binding for a metadata form.
deleteForm [L]	Deletes a metadata form and all data associated with it.
getBindings	Returns zero or more structures, each containing information requested by this method's argument. If no arguments are set, CommonSpot returns information for all bindings.
getBindingTypes	Returns one or more structures, each containing information on the types of bindings to which a metadata form can be bound.
getCategorizationFields	Returns zero or more structures, each containing a field's date and subsite information.
getCategorizationFormatList	Returns zero or more structures, each containing information describing a format type.
getDescriptionFields	Returns zero or more structures, each containing information on a metadata form's description fields, as follows: 'DisplayName' and 'Value'.
getFields	Returns zero or more structures, each containing information about a metadata form's fields such as its label, name, position, and the type.
getForms	Returns zero or more structures, each containing metadata form information. The number of structures returned can be modified by the value of this method's arguments.
getImageSortOrderFields	Returns zero or structures, each containing information on the display name and categorization format value for the way in which image information is sorted.
getMultimediaSortOrderFields	Returns a query describing the fields on which multimedia reports can be sorted.
getRecordsFromFilter	Returns a query populated with metadata form records from the filter. The query will return only columns specified in the ColumnList.
getSortOrderFields	Returns zero or more structures, each containing information on which fields CommonSpot uses to sort information, which can either be by display or value.
getStats	Returns a structure containing the statistics for the metadata form.
saveBindings [L]	Save one or more metadata form bindings and associates each with a binding type and target.
saveProperties [L]	Saves the properties of a new or existing metadata form.