Click or drag to resize
Field Class
This class describes all the methods that apply at field level.
Inheritance Hierarchy

Namespace: Qlik.Engine
Assembly: Qlik.Engine (in Qlik.Engine.dll) Version: 1.1.0.0 (1.1.0.0)
Syntax
public class Field : QixClassBase, IField, 
	IQixClassBase, IDisposable

The Field type exposes the following members.

Constructors
  NameDescription
Public methodField
Initializes a new instance of the Field class
Top
Methods
  NameDescription
Public methodClear

Clears the selections in a specific field.

Public methodClearAllButThis

Maintains the selections in the current field while clearing the selections in the other fields.

Public methodClearAllButThisAsync(Boolean, AsyncHandle)

Maintains the selections in the current field while clearing the selections in the other fields.

Public methodClearAllButThisAsyncT(Boolean, FuncResponse, T, AsyncHandle)

Maintains the selections in the current field while clearing the selections in the other fields.

Public methodClearAsync(AsyncHandle)

Clears the selections in a specific field.

Public methodClearAsyncT(FuncResponse, T, AsyncHandle)

Clears the selections in a specific field.

Public methodDispose
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
(Inherited from QixClassBase.)
Public methodGetAndMode

Returns the AND mode status of a field.

Public methodGetAndModeAsync(AsyncHandle)

Returns the AND mode status of a field.

Public methodGetAndModeAsyncT(FuncResponse, T, AsyncHandle)

Returns the AND mode status of a field.

Public methodGetCardinal

Retrieves the number of distinct values in a field.

Public methodGetCardinalAsync(AsyncHandle)

Retrieves the number of distinct values in a field.

Public methodGetCardinalAsyncT(FuncResponse, T, AsyncHandle)

Retrieves the number of distinct values in a field.

Public methodGetNxProperties

Gets the properties of a field or a variable.

Public methodGetNxPropertiesAsync(AsyncHandle)

Gets the properties of a field or a variable.

Public methodGetNxPropertiesAsyncT(FuncResponse, T, AsyncHandle)

Gets the properties of a field or a variable.

Public methodLock

* Locks all selected values of a specific field if the target (or handle ) is a field

* Locks selected values of a generic object if the target (or handle ) is a generic object

Public methodLockAsync(AsyncHandle)

* Locks all selected values of a specific field if the target (or handle ) is a field

* Locks selected values of a generic object if the target (or handle ) is a generic object

Public methodLockAsyncT(FuncResponse, T, AsyncHandle)

* Locks all selected values of a specific field if the target (or handle ) is a field

* Locks selected values of a generic object if the target (or handle ) is a generic object

Public methodLowLevelSelect

Selects some values in a field.

Public methodLowLevelSelectAsync(IEnumerableInt32, Boolean, Boolean, AsyncHandle)

Selects some values in a field.

Public methodLowLevelSelectAsyncT(IEnumerableInt32, Boolean, Boolean, FuncResponse, T, AsyncHandle)

Selects some values in a field.

Public methodSelect
Public methodSelectAll

Selects all values of a field. Excluded values are also selected.

Public methodSelectAllAsync(Boolean, AsyncHandle)

Selects all values of a field. Excluded values are also selected.

Public methodSelectAllAsyncT(Boolean, FuncResponse, T, AsyncHandle)

Selects all values of a field. Excluded values are also selected.

Public methodSelectAlternative

Selects all alternatives values in a specific field.

In a field that contains at least one selected value, the values that are neither selected nor excluded are alternatives values.
Public methodSelectAlternativeAsync(Boolean, AsyncHandle)

Selects all alternatives values in a specific field.

In a field that contains at least one selected value, the values that are neither selected nor excluded are alternatives values.
Public methodSelectAlternativeAsyncT(Boolean, FuncResponse, T, AsyncHandle)

Selects all alternatives values in a specific field.

In a field that contains at least one selected value, the values that are neither selected nor excluded are alternatives values.
Public methodSelectAsync(String, Boolean, Int32, AsyncHandle)
Public methodSelectAsyncT(String, Boolean, Int32, FuncResponse, T, AsyncHandle)
Public methodSelectExcluded

Inverts the current selections.

Public methodSelectExcludedAsync(Boolean, AsyncHandle)

Inverts the current selections.

Public methodSelectExcludedAsyncT(Boolean, FuncResponse, T, AsyncHandle)

Inverts the current selections.

Public methodSelectPossible

Selects all possible values in a specific field.

Public methodSelectPossibleAsync(Boolean, AsyncHandle)

Selects all possible values in a specific field.

Public methodSelectPossibleAsyncT(Boolean, FuncResponse, T, AsyncHandle)

Selects all possible values in a specific field.

Public methodSelectValues
Public methodSelectValuesAsync(IEnumerableFieldValue, Boolean, Boolean, AsyncHandle)
Public methodSelectValuesAsyncT(IEnumerableFieldValue, Boolean, Boolean, FuncResponse, T, AsyncHandle)
Public methodSetAndMode

Sets a field in the AND mode.

Public methodSetAndModeAsync

Sets a field in the AND mode.

Public methodSetNxProperties

Sets some properties to a field.

Public methodSetNxPropertiesAsync

Sets some properties to a field.

Public methodToggleSelect

Toggle selects field values matching a search string.

Public methodToggleSelectAsync(String, Boolean, Int32, AsyncHandle)

Toggle selects field values matching a search string.

Public methodToggleSelectAsyncT(String, Boolean, Int32, FuncResponse, T, AsyncHandle)

Toggle selects field values matching a search string.

Public methodUnlock

* Unlocks all selected values of a specific field if the target (or handle ) is a field

* Unlocks selected values of a generic object if the target (or handle ) is a generic object

Public methodUnlockAsync(AsyncHandle)

* Unlocks all selected values of a specific field if the target (or handle ) is a field

* Unlocks selected values of a generic object if the target (or handle ) is a generic object

Public methodUnlockAsyncT(FuncResponse, T, AsyncHandle)

* Unlocks all selected values of a specific field if the target (or handle ) is a field

* Unlocks selected values of a generic object if the target (or handle ) is a generic object

Top
Properties
  NameDescription
Public propertyHandle
The handle of the Qlik Sense entity.
(Inherited from QixClassBase.)
Public propertyId
The id of the Qlik Sense entity.
(Inherited from QixClassBase.)
Public propertySession
The session this entity resides in.
(Inherited from QixClassBase.)
Public propertyType
The type of the Qlik Sense entity.
(Inherited from QixClassBase.)
Top
Events
  NameDescription
Public eventChanged
This event fires every time the Qlik Sense entity needs to be updated due to changes in either selectionstate, data or entity properties
(Inherited from QixClassBase.)
Public eventClosed
This event fires when the Qlik Sense entity has been removed or deleted.
(Inherited from QixClassBase.)
Top
See Also