Skip to main content Skip to complementary content

Field Class

Namespace: Qlik.Engine
Assembly: Qlik.Engine.dll

This class describes all the methods that apply at field level.

The handle member in the JSON request for all methods listed in this section is the handle of the field.

Inheritance

Syntax

public class Field : QixClassBase, IField, IQixClassBase, IDisposable, IChangeNotifier

Constructors

Name Description
Field(Int32)

Methods

Name Description
Clear()

Clears the selections in a specific field.

ClearAllButThis(Boolean)

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

ClearAllButThisAsync(AsyncHandle, Boolean)

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

ClearAllButThisAsync(Boolean)

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

ClearAllButThisAsync<T>(AsyncHandle, Func<Response, T>, Boolean)

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

ClearAsync()

Clears the selections in a specific field.

ClearAsync(AsyncHandle)

Clears the selections in a specific field.

ClearAsync<T>(AsyncHandle, Func<Response, T>)

Clears the selections in a specific field.

GetAndMode()

Returns the AND mode status of a field.

GetAndModeAsync()

Returns the AND mode status of a field.

GetAndModeAsync(AsyncHandle)

Returns the AND mode status of a field.

GetAndModeAsync<T>(AsyncHandle, Func<Response, T>)

Returns the AND mode status of a field.

GetCardinal()

Retrieves the number of distinct values in a field.

GetCardinalAsync()

Retrieves the number of distinct values in a field.

GetCardinalAsync(AsyncHandle)

Retrieves the number of distinct values in a field.

GetCardinalAsync<T>(AsyncHandle, Func<Response, T>)

Retrieves the number of distinct values in a field.

GetNxProperties()

Gets the properties of a field.

GetNxPropertiesAsync()

Gets the properties of a field.

GetNxPropertiesAsync(AsyncHandle)

Gets the properties of a field.

GetNxPropertiesAsync<T>(AsyncHandle, Func<Response, T>)

Gets the properties of a field.

Lock()

Locks all selected values of a specific field.

LockAsync()

Locks all selected values of a specific field.

LockAsync(AsyncHandle)

Locks all selected values of a specific field.

LockAsync<T>(AsyncHandle, Func<Response, T>)

Locks all selected values of a specific field.

LowLevelSelect(IEnumerable<Int32>, Boolean, Boolean)

Selects some values in a field, by entering the element numbers related to the values to select.

LowLevelSelectAsync(AsyncHandle, IEnumerable<Int32>, Boolean, Boolean)

Selects some values in a field, by entering the element numbers related to the values to select.

LowLevelSelectAsync(IEnumerable<Int32>, Boolean, Boolean)

Selects some values in a field, by entering the element numbers related to the values to select.

LowLevelSelectAsync<T>(AsyncHandle, Func<Response, T>, IEnumerable<Int32>, Boolean, Boolean)

Selects some values in a field, by entering the element numbers related to the values to select.

OnClearAllButThisAsync(Response)
OnClearAsync(Response)
OnGetAndModeAsync(Response)
OnGetCardinalAsync(Response)
OnGetNxPropertiesAsync(Response)
OnLockAsync(Response)
OnLowLevelSelectAsync(Response)
OnSelectAllAsync(Response)
OnSelectAlternativeAsync(Response)
OnSelectAsync(Response)
OnSelectExcludedAsync(Response)
OnSelectPossibleAsync(Response)
OnSelectValuesAsync(Response)
OnToggleSelectAsync(Response)
OnUnlockAsync(Response)
Select(String, Boolean, Int32)

Selects field values matching a search string.

SelectAll(Boolean)

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

SelectAllAsync(AsyncHandle, Boolean)

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

SelectAllAsync(Boolean)

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

SelectAllAsync<T>(AsyncHandle, Func<Response, T>, Boolean)

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

SelectAlternative(Boolean)

Selects all alternatives values in a specific field.

SelectAlternativeAsync(AsyncHandle, Boolean)

Selects all alternatives values in a specific field.

SelectAlternativeAsync(Boolean)

Selects all alternatives values in a specific field.

SelectAlternativeAsync<T>(AsyncHandle, Func<Response, T>, Boolean)

Selects all alternatives values in a specific field.

SelectAsync(AsyncHandle, String, Boolean, Int32)

Selects field values matching a search string.

SelectAsync(String, Boolean, Int32)

Selects field values matching a search string.

SelectAsync<T>(AsyncHandle, Func<Response, T>, String, Boolean, Int32)

Selects field values matching a search string.

SelectExcluded(Boolean)

Inverts the current selections.

SelectExcludedAsync(AsyncHandle, Boolean)

Inverts the current selections.

SelectExcludedAsync(Boolean)

Inverts the current selections.

SelectExcludedAsync<T>(AsyncHandle, Func<Response, T>, Boolean)

Inverts the current selections.

SelectPossible(Boolean)

Selects all possible values in a specific field.

SelectPossibleAsync(AsyncHandle, Boolean)

Selects all possible values in a specific field.

SelectPossibleAsync(Boolean)

Selects all possible values in a specific field.

SelectPossibleAsync<T>(AsyncHandle, Func<Response, T>, Boolean)

Selects all possible values in a specific field.

SelectValues(IEnumerable<FieldValue>, Boolean, Boolean)

Selects some values in a field, by entering the values to select.

SelectValuesAsync(AsyncHandle, IEnumerable<FieldValue>, Boolean, Boolean)

Selects some values in a field, by entering the values to select.

SelectValuesAsync(IEnumerable<FieldValue>, Boolean, Boolean)

Selects some values in a field, by entering the values to select.

SelectValuesAsync<T>(AsyncHandle, Func<Response, T>, IEnumerable<FieldValue>, Boolean, Boolean)

Selects some values in a field, by entering the values to select.

SetAndMode(Boolean)

Sets a field in the AND mode.

SetAndModeAsync(AsyncHandle, Boolean)

Sets a field in the AND mode.

SetAndModeAsync(Boolean)

Sets a field in the AND mode.

SetNxProperties(NxFieldProperties)

Sets some properties to a field.

SetNxPropertiesAsync(AsyncHandle, NxFieldProperties)

Sets some properties to a field.

SetNxPropertiesAsync(NxFieldProperties)

Sets some properties to a field.

ToggleSelect(String, Boolean, Int32)

Toggle selects field values matching a search string.

ToggleSelectAsync(AsyncHandle, String, Boolean, Int32)

Toggle selects field values matching a search string.

ToggleSelectAsync(String, Boolean, Int32)

Toggle selects field values matching a search string.

ToggleSelectAsync<T>(AsyncHandle, Func<Response, T>, String, Boolean, Int32)

Toggle selects field values matching a search string.

Unlock()

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

UnlockAsync()

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

UnlockAsync(AsyncHandle)

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

UnlockAsync<T>(AsyncHandle, Func<Response, T>)

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

Did this page help you?

If you find any issues with this page or its content – a typo, a missing step, or a technical error – let us know how we can improve!