Field.ToggleSelectAsync Method (String, Boolean, Int32, String)

Field ToggleSelectAsync Method (String, Boolean, Int32, String)

Qlik Sense .NET SDK - API Reference

Toggle selects field values matching a search string.

Namespace: Qlik.Engine
Assembly: Qlik.Engine (in Qlik.Engine.dll) Version: 1.0.1.0 (1.0.1.0)

Syntax

public Task<bool> ToggleSelectAsync(
	string match,
	bool softLock = false,
	int excludedValuesMode = 0,
	string userHandle = null
)

public Task<bool> ToggleSelectAsync(
	string match,
	bool softLock = false,
	int excludedValuesMode = 0,
	string userHandle = null
)

Public Function ToggleSelectAsync ( 
	match As String,
	Optional softLock As Boolean = false,
	Optional excludedValuesMode As Integer = 0,
	Optional userHandle As String = Nothing
) As Task(Of Boolean)

Public Function ToggleSelectAsync ( 
	match As String,
	Optional softLock As Boolean = false,
	Optional excludedValuesMode As Integer = 0,
	Optional userHandle As String = Nothing
) As Task(Of Boolean)

Parameters

match: Type: System String
String to search for. Can contain wild cards or numeric search criteria.

softLock (Optional): Type: System Boolean
Set to true to ignore locks; in that case, locked fields can be selected. The default value is false. This parameter is optional.

excludedValuesMode (Optional): Type: System Int32
Include excluded values in search. This parameter is optional.

userHandle (Optional): Type: System String
Handle identifier

Return Value

Type:

Task

Boolean

Implements

IField ToggleSelectAsync(String, Boolean, Int32, String)