Site.getAvailableForms (Method)
Returns zero or more records describing the resulting forms, based on the type specified (Bound Simple Form, Standard Simple Form, Custom Element, Metadata Form, Query By Example Form, XML Publication Definition).
Returns:
Site_GetAvailableForms_Result (query)
Each row of the returned query results has the following fields:
Field Name | Type | Description |
---|---|---|
FormID | ObjectFormID | Either the ID of a custom element, metadata form, xml publication definition, qbe form, or simple form. |
FormName | PlainText_NonNull_255 | The name of the form. |
FormType | ObjectFormType | The type of form. |
Arguments:
Name | Type | Required | Description |
---|---|---|---|
formTypeFilter | ObjectFormTypeList_ALL | Optional. Defaults to 'All'. | A comma delimited list of form types to return, or 'All'. |
excludeFormIDList | ObjectFormIDList_EmptyString | Optional. Defaults to an empty string. | The ID of the form to exclude from the list. |
searchString | String | Optional. Defaults to an empty string. | The text to search against. |
searchOperator | SearchOperator_EmptyString | Optional. Defaults to an empty string. | The operator used to perform the search; for example, 'Contains', 'Begins with', 'Equals', and so on. |
Context:
License Requirements | None |
Permission Requirements | ContributorOrServerCode |
Deny Context | None |
Require Context | None |
Author Lock | (not required) |
Transaction Logging | Transaction logging is disabled for this method |
Customization | Customization is not supported for this method. |
Error Codes:
None
Notes:
None