Click or drag to resize

ChoicesProviderOptions Class


Contains information on how the choices for a enumerative element should be presented.
Inheritance Hierarchy
SystemObject
  Ingeniux.CMSChoicesProviderOptions

Namespace:  Ingeniux.CMS
Assembly:  Ingeniux.CMS.CSAPI (in Ingeniux.CMS.CSAPI.dll) Version: 10.3.169
Syntax
public class ChoicesProviderOptions

The ChoicesProviderOptions type exposes the following members.

Constructors
  NameDescription
Public methodChoicesProviderOptions
Initializes a new instance of the ChoicesProviderOptions class
Top
Fields
  NameDescription
Public fieldFilter
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 fieldPageId
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 fieldSort
True by default. If left set to true, the data returned from this function is sorted before the response is sent to the client. If changed to false, the values returned by GetElementValues will not be sorted. This allows the developer to send items in a specific order. This option applies only to Multiselect Elements, not Enumeration Elements.
Public fieldValidate
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