ChoicesProviderOptions Fields Ingeniux CMS Content Store API

The ChoicesProviderOptions type exposes the following members.

Fields

  Name Description
Public field Filter
If the client requests that the data be filtered (typically by matching a "starts-with" test of the value), then this property holds the string to be tested against. If this option is left unchanged, the system filters the results. The developer has the option to apply the filter here, after which the filter property should be changed to be an empty string or a Boolean false, so that the system does not try to apply the filter again. This option is available to apply more-efficient filtering techniques (such as a SQL "WHERE" clause, in the case of selecting from a database). This option applies only to Multiselect Elements, not Enumeration Elements.
Public field PageId
This input can be used to determine the page for which the client is requesting data. This allows the developer to return different data based on page ID (example: "x123") This option applies to both Multiselect Elements and Enumeration Elements.
Public field Sort
Public field Validate
True by default. This option instructs the system to remove empty values from the list before the response is sent to the client. The validate property can be set to false in order to disable this behavior and potentially increase performance. This option applies only to Multiselect Elements, not Enumeration Elements.
Top
See Also

Reference