Skip to main content Skip to complementary content

GenericVariable Class

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

This class describes all the methods that apply at generic variable level.

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

Inheritance

Syntax

public class GenericVariable : PropertyContainer, ITransient, IGenericVariable, IPropertyContainer, IQixClassBase, IDisposable, IChangeNotifier

Constructors

Name Description
GenericVariable(Int32)

Properties

Name Description
IsTransient

Indicates whether or not this object is a session variable.

Layout
Properties

Methods

Name Description
ApplyPatches(IEnumerable<NxPatch>)

Applies a patch to the properties of a variable. Allows an update to some of the properties. It should not be possible to patch "/qInfo/qId",

and it will be forbidden in the near future.

ApplyPatchesAsync(AsyncHandle, IEnumerable<NxPatch>)

Applies a patch to the properties of a variable. Allows an update to some of the properties. It should not be possible to patch "/qInfo/qId",

and it will be forbidden in the near future.

ApplyPatchesAsync(IEnumerable<NxPatch>)

Applies a patch to the properties of a variable. Allows an update to some of the properties. It should not be possible to patch "/qInfo/qId",

and it will be forbidden in the near future.

GetInfo()

Returns the type and identifier of the object.

GetInfoAsync()

Returns the type and identifier of the object.

GetInfoAsync(AsyncHandle)

Returns the type and identifier of the object.

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

Returns the type and identifier of the object.

GetLayout()

Evaluates an object and displays its properties including the dynamic properties.

If the member delta is set to true in the request object, only the delta is evaluated.

GetLayoutAsync()

Evaluates an object and displays its properties including the dynamic properties.

If the member delta is set to true in the request object, only the delta is evaluated.

GetLayoutAsync(AsyncHandle)

Evaluates an object and displays its properties including the dynamic properties.

If the member delta is set to true in the request object, only the delta is evaluated.

GetProperties()

Shows the properties of an object.

The following is always returned in the output:

GetPropertiesAsync()

Shows the properties of an object.

The following is always returned in the output:

GetPropertiesAsync(AsyncHandle)

Shows the properties of an object.

The following is always returned in the output:

GetRawContent()

Returns the raw value of a variable.

GetRawContentAsync()

Returns the raw value of a variable.

GetRawContentAsync(AsyncHandle)

Returns the raw value of a variable.

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

Returns the raw value of a variable.

MarkAsTransient()

Mark object as being a session variable and ensure that it is correctly destroyed when the .NET object is disposed.

OnGetInfoAsync(Response)
OnGetLayoutAsync(Response)
OnGetPropertiesAsync(Response)
OnGetRawContentAsync(Response)
SetDualValue(String, Double)

Sets the value of a dual variable.

SetDualValueAsync(AsyncHandle, String, Double)

Sets the value of a dual variable.

SetDualValueAsync(String, Double)

Sets the value of a dual variable.

SetNumValue(Double)

Sets a numerical value to a variable.

SetNumValueAsync(AsyncHandle, Double)

Sets a numerical value to a variable.

SetNumValueAsync(Double)

Sets a numerical value to a variable.

SetProperties(GenericVariableProperties)

Sets some properties for a variable.

SetPropertiesAsync(AsyncHandle, GenericVariableProperties)

Sets some properties for a variable.

SetPropertiesAsync(GenericVariableProperties)

Sets some properties for a variable.

SetStringValue(String)

Sets a string value to a variable.

SetStringValueAsync(AsyncHandle, String)

Sets a string value to a variable.

SetStringValueAsync(String)

Sets a string value to a variable.

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!