Click or drag to resize
IApp Interface
App / Doc class
This class describes all the methods that apply at app level.

Namespace: Qlik.Engine
Assembly: Qlik.Engine (in Qlik.Engine.dll) Version: 1.1.0.0 (1.1.0.0)
Syntax
public interface IApp : IQixClassBase, IDisposable

The IApp type exposes the following members.

Methods
  NameDescription
Public methodAbortModal

Aborts any selection mode in an app. For more information about selection mode, see BeginSelections method.

Public methodAbortModalAsync

Aborts any selection mode in an app. For more information about selection mode, see BeginSelections method.

Public methodAddAlternateState

Adds an alternate state in the app.

You can create multiple states within a Qlik Sense app and apply these states to specific objects within the app. Objects in a given state are not affected by user selections in the other states.

Public methodAddAlternateStateAsync

Adds an alternate state in the app.

You can create multiple states within a Qlik Sense app and apply these states to specific objects within the app. Objects in a given state are not affected by user selections in the other states.

Public methodAddFieldFromExpression

Adds a field on the fly.

The expression of a field on the fly is persisted but not its values.
Public methodAddFieldFromExpressionAsync(String, String, AsyncHandle)

Adds a field on the fly.

The expression of a field on the fly is persisted but not its values.
Public methodAddFieldFromExpressionAsyncT(String, String, FuncResponse, T, AsyncHandle)

Adds a field on the fly.

The expression of a field on the fly is persisted but not its values.
Public methodApplyGenericBookmark

Applies a bookmark.

Public methodApplyGenericBookmarkAsync(String, AsyncHandle)

Applies a bookmark.

Public methodApplyGenericBookmarkAsyncT(String, FuncResponse, T, AsyncHandle)

Applies a bookmark.

Public methodAssignDerivedFieldFor
Public methodAssignDerivedFieldForAsync
Public methodBack

Loads the last logical operation (if any).

Public methodBackAsync

Loads the last logical operation (if any).

Public methodBackCount

Returns the number of entries on the Back stack.

Public methodBackCountAsync(AsyncHandle)

Returns the number of entries on the Back stack.

Public methodBackCountAsyncT(FuncResponse, T, AsyncHandle)

Returns the number of entries on the Back stack.

Public methodCheckExpression

Checks if a given expression is valid.

Public methodCheckExpressionAsync(String, IEnumerableString, AsyncHandle)

Checks if a given expression is valid.

Public methodCheckExpressionAsyncT(String, IEnumerableString, FuncResponse, T, AsyncHandle)

Checks if a given expression is valid.

Public methodCheckNumberOrExpression

Checks if:

* a given expression is valid

* a number is correct according to the locale.

Public methodCheckNumberOrExpressionAsync(String, AsyncHandle)

Checks if:

* a given expression is valid

* a number is correct according to the locale.

Public methodCheckNumberOrExpressionAsyncT(String, FuncResponse, T, AsyncHandle)

Checks if:

* a given expression is valid

* a number is correct according to the locale.

Public methodCheckScriptSyntax

Checks the syntax of a script.

Public methodCheckScriptSyntaxAsync(AsyncHandle)

Checks the syntax of a script.

Public methodCheckScriptSyntaxAsyncT(FuncResponse, T, AsyncHandle)

Checks the syntax of a script.

Public methodClearAll

Clears all selections in all fields of the current app.

Public methodClearAllAsync

Clears all selections in all fields of the current app.

Public methodClearUndoBuffer

Clears entirely the undo and redo buffer.

Public methodClearUndoBufferAsync

Clears entirely the undo and redo buffer.

Public methodCloneGenericBookmark

Clones a bookmark.

To clone:

* a dimension, use CloneDimension method

* a measure, use CloneMeasure method

* an object, use CloneObject method

Public methodCloneGenericBookmarkAsync(String, AsyncHandle)

Clones a bookmark.

To clone:

* a dimension, use CloneDimension method

* a measure, use CloneMeasure method

* an object, use CloneObject method

Public methodCloneGenericBookmarkAsyncT(String, FuncResponse, T, AsyncHandle)

Clones a bookmark.

To clone:

* a dimension, use CloneDimension method

* a measure, use CloneMeasure method

* an object, use CloneObject method

Public methodCloneGenericDimension

Clones a dimension.

To clone:

* a bookmark, use CloneBookmark method

* a measure, use CloneMeasure method

* an object, use CloneObject method

Public methodCloneGenericDimensionAsync(String, AsyncHandle)

Clones a dimension.

To clone:

* a bookmark, use CloneBookmark method

* a measure, use CloneMeasure method

* an object, use CloneObject method

Public methodCloneGenericDimensionAsyncT(String, FuncResponse, T, AsyncHandle)

Clones a dimension.

To clone:

* a bookmark, use CloneBookmark method

* a measure, use CloneMeasure method

* an object, use CloneObject method

Public methodCloneGenericMeasure

Clones a measure.

To clone:

* a bookmark, use CloneBookmark method

* a dimension, use CloneDimension method

* an object, use CloneObject method

Public methodCloneGenericMeasureAsync(String, AsyncHandle)

Clones a measure.

To clone:

* a bookmark, use CloneBookmark method

* a dimension, use CloneDimension method

* an object, use CloneObject method

Public methodCloneGenericMeasureAsyncT(String, FuncResponse, T, AsyncHandle)

Clones a measure.

To clone:

* a bookmark, use CloneBookmark method

* a dimension, use CloneDimension method

* an object, use CloneObject method

Public methodCloneGenericObject

Clones any generic object (for example list objects, hypercubes, slides), sheets and stories. The clone method works for both app objects and child objects.

When you clone an object that contains children, the children are cloned as well.

It is not possible to clone a session object.

To clone:

* a bookmark, use CloneBookmark method

* a dimension, use CloneDimension method

* a measure, use CloneMeasure method

Public methodCloneGenericObjectAsync(String, AsyncHandle)

Clones any generic object (for example list objects, hypercubes, slides), sheets and stories. The clone method works for both app objects and child objects.

When you clone an object that contains children, the children are cloned as well.

It is not possible to clone a session object.

To clone:

* a bookmark, use CloneBookmark method

* a dimension, use CloneDimension method

* a measure, use CloneMeasure method

Public methodCloneGenericObjectAsyncT(String, FuncResponse, T, AsyncHandle)

Clones any generic object (for example list objects, hypercubes, slides), sheets and stories. The clone method works for both app objects and child objects.

When you clone an object that contains children, the children are cloned as well.

It is not possible to clone a session object.

To clone:

* a bookmark, use CloneBookmark method

* a dimension, use CloneDimension method

* a measure, use CloneMeasure method

Public methodCommitDraft

Commits the draft of an object that was previously created by invoking the CreateDraft method.

Committing a draft replaces the corresponding published object.

Public methodCommitDraftAsync

Commits the draft of an object that was previously created by invoking the CreateDraft method.

Committing a draft replaces the corresponding published object.

Public methodCreateConnection

Creates a connection. A connection indicates from which data source, the data should be taken.

Public methodCreateConnectionAsync(Connection, AsyncHandle)

Creates a connection. A connection indicates from which data source, the data should be taken.

Public methodCreateConnectionAsyncT(Connection, FuncResponse, T, AsyncHandle)

Creates a connection. A connection indicates from which data source, the data should be taken.

Public methodCreateDerivedDefinition
Public methodCreateDerivedDefinitionAsync(GenericDerivedDefinitionProperties, AsyncHandle)
Public methodCreateDerivedDefinitionAsyncT(GenericDerivedDefinitionProperties, FuncResponse, T, AsyncHandle)
Public methodCreateDerivedFields
Public methodCreateDerivedFieldsAsync(GenericDerivedFieldsProperties, AsyncHandle)
Public methodCreateDerivedFieldsAsyncT(GenericDerivedFieldsProperties, FuncResponse, T, AsyncHandle)
Public methodCreateDraft

Creates a draft of an object.

This method can be used to create a draft of a sheet that is published. This is a way to continue working on a sheet that is published.

The draft can replace the published sheet by invoking the CommitDraft method.

Public methodCreateDraftAsync(String, AsyncHandle)

Creates a draft of an object.

This method can be used to create a draft of a sheet that is published. This is a way to continue working on a sheet that is published.

The draft can replace the published sheet by invoking the CommitDraft method.

Public methodCreateDraftAsyncT(String, FuncResponse, T, AsyncHandle)

Creates a draft of an object.

This method can be used to create a draft of a sheet that is published. This is a way to continue working on a sheet that is published.

The draft can replace the published sheet by invoking the CommitDraft method.

Public methodCreateGenericBookmark

Creates a bookmark.

Public methodCreateGenericBookmarkAsync(GenericBookmarkProperties, AsyncHandle)

Creates a bookmark.

Public methodCreateGenericBookmarkAsyncT(GenericBookmarkProperties, FuncResponse, T, AsyncHandle)

Creates a bookmark.

Public methodCreateGenericDimension

Creates a master dimension.

A master dimension is stored in the library of an app and can be used in many objects. Several generic objects can contain the same dimension.

Public methodCreateGenericDimensionAsync(GenericDimensionProperties, AsyncHandle)

Creates a master dimension.

A master dimension is stored in the library of an app and can be used in many objects. Several generic objects can contain the same dimension.

Public methodCreateGenericDimensionAsyncT(GenericDimensionProperties, FuncResponse, T, AsyncHandle)

Creates a master dimension.

A master dimension is stored in the library of an app and can be used in many objects. Several generic objects can contain the same dimension.

Public methodCreateGenericMeasure

Creates a master measure.

A master measure is stored in the library of an app and can be used in many objects. Several generic objects can contain the same measure.

Public methodCreateGenericMeasureAsync(GenericMeasureProperties, AsyncHandle)

Creates a master measure.

A master measure is stored in the library of an app and can be used in many objects. Several generic objects can contain the same measure.

Public methodCreateGenericMeasureAsyncT(GenericMeasureProperties, FuncResponse, T, AsyncHandle)

Creates a master measure.

A master measure is stored in the library of an app and can be used in many objects. Several generic objects can contain the same measure.

Public methodCreateGenericObject

Creates a generic object at app level. For more information on generic objects, see Generic object definition.

It is possible to create a generic object that is linked to another object.

A linked object is an object that points to a linking object. The linking object is defined in the properties of the linked object (in qExtendsId).

The linked object has the same properties as the linking object.

The linking object cannot be a transient object.
Public methodCreateGenericObjectAsync(GenericObjectProperties, AsyncHandle)

Creates a generic object at app level. For more information on generic objects, see Generic object definition.

It is possible to create a generic object that is linked to another object.

A linked object is an object that points to a linking object. The linking object is defined in the properties of the linked object (in qExtendsId).

The linked object has the same properties as the linking object.

The linking object cannot be a transient object.
Public methodCreateGenericObjectAsyncT(GenericObjectProperties, FuncResponse, T, AsyncHandle)

Creates a generic object at app level. For more information on generic objects, see Generic object definition.

It is possible to create a generic object that is linked to another object.

A linked object is an object that points to a linking object. The linking object is defined in the properties of the linked object (in qExtendsId).

The linked object has the same properties as the linking object.

The linking object cannot be a transient object.
Public methodCreateGenericSessionObject

Creates a transient object. For example, you can use a transient object to create an app overview or a story overview.

It is possible to create a transient object that is linked to another object.

A linked object is an object that points to a linking object. The linking object is defined in the properties of the linked object (in qExtendsId).

The linked object has the same properties as the linking object.

The linking object cannot be a transient object.
Public methodCreateGenericSessionObjectAsync(GenericObjectProperties, AsyncHandle)

Creates a transient object. For example, you can use a transient object to create an app overview or a story overview.

It is possible to create a transient object that is linked to another object.

A linked object is an object that points to a linking object. The linking object is defined in the properties of the linked object (in qExtendsId).

The linked object has the same properties as the linking object.

The linking object cannot be a transient object.
Public methodCreateGenericSessionObjectAsyncT(GenericObjectProperties, FuncResponse, T, AsyncHandle)

Creates a transient object. For example, you can use a transient object to create an app overview or a story overview.

It is possible to create a transient object that is linked to another object.

A linked object is an object that points to a linking object. The linking object is defined in the properties of the linked object (in qExtendsId).

The linked object has the same properties as the linking object.

The linking object cannot be a transient object.
Public methodCreateVariable

Creates a script variable.

To set some properties to the variable, use the SetNxProperties method.
Public methodCreateVariableAsync(String, AsyncHandle)

Creates a script variable.

To set some properties to the variable, use the SetNxProperties method.
Public methodCreateVariableAsyncT(String, FuncResponse, T, AsyncHandle)

Creates a script variable.

To set some properties to the variable, use the SetNxProperties method.
Public methodDeleteConnection

Deletes a connection.

Public methodDeleteConnectionAsync

Deletes a connection.

Public methodDestroyDraft

Removes the draft of an object.

The children of the draft object (if any) are removed as well.

Public methodDestroyDraftAsync(String, String, AsyncHandle)

Removes the draft of an object.

The children of the draft object (if any) are removed as well.

Public methodDestroyDraftAsyncT(String, String, FuncResponse, T, AsyncHandle)

Removes the draft of an object.

The children of the draft object (if any) are removed as well.

Public methodDestroyGenericBookmark

Removes a bookmark.

Public methodDestroyGenericBookmarkAsync(String, AsyncHandle)

Removes a bookmark.

Public methodDestroyGenericBookmarkAsyncT(String, FuncResponse, T, AsyncHandle)

Removes a bookmark.

Public methodDestroyGenericDimension

Removes a dimension.

Public methodDestroyGenericDimensionAsync(String, AsyncHandle)

Removes a dimension.

Public methodDestroyGenericDimensionAsyncT(String, FuncResponse, T, AsyncHandle)

Removes a dimension.

Public methodDestroyGenericMeasure

Removes a generic measure.

Public methodDestroyGenericMeasureAsync(String, AsyncHandle)

Removes a generic measure.

Public methodDestroyGenericMeasureAsyncT(String, FuncResponse, T, AsyncHandle)

Removes a generic measure.

Public methodDestroyGenericObject

Removes an app object.

The children of the object (if any) are removed as well.

Public methodDestroyGenericObjectAsync(String, AsyncHandle)

Removes an app object.

The children of the object (if any) are removed as well.

Public methodDestroyGenericObjectAsyncT(String, FuncResponse, T, AsyncHandle)

Removes an app object.

The children of the object (if any) are removed as well.

Public methodDestroyGenericSessionObject

Removes a transient object.

Public methodDestroyGenericSessionObjectAsync(String, AsyncHandle)

Removes a transient object.

Public methodDestroyGenericSessionObjectAsyncT(String, FuncResponse, T, AsyncHandle)

Removes a transient object.

Public methodDoReload

Reloads the script that is set in an app.

Public methodDoReloadAsync(Int32, Boolean, Boolean, AsyncHandle)

Reloads the script that is set in an app.

Public methodDoReloadAsyncT(Int32, Boolean, Boolean, FuncResponse, T, AsyncHandle)

Reloads the script that is set in an app.

Public methodDoSave

Saves an app. All objects and data in the data model are saved.

Public methodDoSaveAsync

Saves an app. All objects and data in the data model are saved.

Public methodEvaluate
Public methodEvaluateAsync(String, AsyncHandle)
Public methodEvaluateAsyncT(String, FuncResponse, T, AsyncHandle)
Public methodEvaluateEx
Public methodEvaluateExAsync(String, AsyncHandle)
Public methodEvaluateExAsyncT(String, FuncResponse, T, AsyncHandle)
Public methodFindMatchingFields

Retrieves any fields that belong to the same archipelago as the specified field and that match at least one of the specified tags.

Tags set by Qlik Sense are prefixed by the $ sign.
Public methodFindMatchingFieldsAsync(String, IEnumerableString, AsyncHandle)

Retrieves any fields that belong to the same archipelago as the specified field and that match at least one of the specified tags.

Tags set by Qlik Sense are prefixed by the $ sign.
Public methodFindMatchingFieldsAsyncT(String, IEnumerableString, FuncResponse, T, AsyncHandle)

Retrieves any fields that belong to the same archipelago as the specified field and that match at least one of the specified tags.

Tags set by Qlik Sense are prefixed by the $ sign.
Public methodForward

Loads the next logical operation (if any).

Public methodForwardAsync

Loads the next logical operation (if any).

Public methodForwardCount

Returns the number of entries on the Forward stack.

Public methodForwardCountAsync(AsyncHandle)

Returns the number of entries on the Forward stack.

Public methodForwardCountAsyncT(FuncResponse, T, AsyncHandle)

Returns the number of entries on the Forward stack.

Public methodGenerateThumbNail
Public methodGenerateThumbNailAsync(String, AsyncHandle)
Public methodGenerateThumbNailAsyncT(String, FuncResponse, T, AsyncHandle)
Public methodGetAllDerivedFields
Public methodGetAllDerivedFieldsAsync(AsyncHandle)
Public methodGetAllDerivedFieldsAsyncT(FuncResponse, T, AsyncHandle)
Public methodGetAppLayout

Evaluates an app.

Returns dynamic properties (if any) in addition to the engine (fixed) properties.

Public methodGetAppLayoutAsync(AsyncHandle)

Evaluates an app.

Returns dynamic properties (if any) in addition to the engine (fixed) properties.

Public methodGetAppLayoutAsyncT(FuncResponse, T, AsyncHandle)

Evaluates an app.

Returns dynamic properties (if any) in addition to the engine (fixed) properties.

Public methodGetAppProperties

Gets the dynamic properties of an app.

Public methodGetAppPropertiesAsync(AsyncHandle)

Gets the dynamic properties of an app.

Public methodGetAppPropertiesAsyncT(FuncResponse, T, AsyncHandle)

Gets the dynamic properties of an app.

Public methodGetConnection

Retrieves a connection and returns:

* The creation time of the connection

* The identifier of the connection

* The type of the connection

* The name of the connection

* The connection string

Public methodGetConnectionAsync(String, AsyncHandle)

Retrieves a connection and returns:

* The creation time of the connection

* The identifier of the connection

* The type of the connection

* The name of the connection

* The connection string

Public methodGetConnectionAsyncT(String, FuncResponse, T, AsyncHandle)

Retrieves a connection and returns:

* The creation time of the connection

* The identifier of the connection

* The type of the connection

* The name of the connection

* The connection string

Public methodGetConnections

Lists the connections in an app.

Public methodGetConnectionsAsync(AsyncHandle)

Lists the connections in an app.

Public methodGetConnectionsAsyncT(FuncResponse, T, AsyncHandle)

Lists the connections in an app.

Public methodGetDatabaseInfo

Gives information about an ODBC, OLEDB or CUSTOM connection. See Outputs for more details.

Public methodGetDatabaseInfoAsync(String, AsyncHandle)

Gives information about an ODBC, OLEDB or CUSTOM connection. See Outputs for more details.

Public methodGetDatabaseInfoAsyncT(String, FuncResponse, T, AsyncHandle)

Gives information about an ODBC, OLEDB or CUSTOM connection. See Outputs for more details.

Public methodGetDatabaseOwners

Lists the owners of a database for a ODBC, OLEDB or CUSTOM connection.

Public methodGetDatabaseOwnersAsync(String, String, AsyncHandle)

Lists the owners of a database for a ODBC, OLEDB or CUSTOM connection.

Public methodGetDatabaseOwnersAsyncT(String, String, FuncResponse, T, AsyncHandle)

Lists the owners of a database for a ODBC, OLEDB or CUSTOM connection.

Public methodGetDatabases

Lists the databases inside a ODBC, OLEDB or CUSTOM data source.

Public methodGetDatabasesAsync(String, AsyncHandle)

Lists the databases inside a ODBC, OLEDB or CUSTOM data source.

Public methodGetDatabasesAsyncT(String, FuncResponse, T, AsyncHandle)

Lists the databases inside a ODBC, OLEDB or CUSTOM data source.

Public methodGetDatabaseTableFields

Lists the fields inside a table of a database for a ODBC, OLEDB or CUSTOM connection.

Public methodGetDatabaseTableFieldsAsync(String, String, String, String, AsyncHandle)

Lists the fields inside a table of a database for a ODBC, OLEDB or CUSTOM connection.

Public methodGetDatabaseTableFieldsAsyncT(String, String, String, String, FuncResponse, T, AsyncHandle)

Lists the fields inside a table of a database for a ODBC, OLEDB or CUSTOM connection.

Public methodGetDatabaseTablePreview

Retrieves the values of the specified table of a database for a ODBC, OLEDB or CUSTOM connection.

Public methodGetDatabaseTablePreviewAsync(String, String, String, String, AsyncHandle)

Retrieves the values of the specified table of a database for a ODBC, OLEDB or CUSTOM connection.

Public methodGetDatabaseTablePreviewAsyncT(String, String, String, String, FuncResponse, T, AsyncHandle)

Retrieves the values of the specified table of a database for a ODBC, OLEDB or CUSTOM connection.

Public methodGetDatabaseTables

Lists the tables inside a database for a ODBC, OLEDB or CUSTOM connection.

Public methodGetDatabaseTablesAsync(String, String, String, AsyncHandle)

Lists the tables inside a database for a ODBC, OLEDB or CUSTOM connection.

Public methodGetDatabaseTablesAsyncT(String, String, String, FuncResponse, T, AsyncHandle)

Lists the tables inside a database for a ODBC, OLEDB or CUSTOM connection.

Public methodGetDerivedDefinitionByName
Public methodGetDerivedDefinitionByNameAsync(String, AsyncHandle)
Public methodGetDerivedDefinitionByNameAsyncT(String, FuncResponse, T, AsyncHandle)
Public methodGetDerivedFields
Public methodGetDerivedFieldsAsync(String, AsyncHandle)
Public methodGetDerivedFieldsAsyncT(String, FuncResponse, T, AsyncHandle)
Public methodGetEmptyScript

Creates a script that contains one section. This section contains Set statements that give localized information from the regional settings of the computer.

The computer regional settings are retrieved when the engine starts.
Public methodGetEmptyScriptAsync(String, AsyncHandle)

Creates a script that contains one section. This section contains Set statements that give localized information from the regional settings of the computer.

The computer regional settings are retrieved when the engine starts.
Public methodGetEmptyScriptAsyncT(String, FuncResponse, T, AsyncHandle)

Creates a script that contains one section. This section contains Set statements that give localized information from the regional settings of the computer.

The computer regional settings are retrieved when the engine starts.
Public methodGetFavoriteVariables

Retrieves the variables that are tagged as favorite.

Public methodGetFavoriteVariablesAsync(AsyncHandle)

Retrieves the variables that are tagged as favorite.

Public methodGetFavoriteVariablesAsyncT(FuncResponse, T, AsyncHandle)

Retrieves the variables that are tagged as favorite.

Public methodGetField

Retrieves the handle of a field.

Public methodGetFieldAsync(String, String, AsyncHandle)

Retrieves the handle of a field.

Public methodGetFieldAsyncT(String, String, FuncResponse, T, AsyncHandle)

Retrieves the handle of a field.

Public methodGetFieldDescription

Retrieves the description of a field.

Public methodGetFieldDescriptionAsync(String, AsyncHandle)

Retrieves the description of a field.

Public methodGetFieldDescriptionAsyncT(String, FuncResponse, T, AsyncHandle)

Retrieves the description of a field.

Public methodGetFileTableFields

Lists the fields of a table for a folder connection.

Public methodGetFileTableFieldsAsync(String, String, FileDataFormat, String, AsyncHandle)

Lists the fields of a table for a folder connection.

Public methodGetFileTableFieldsAsyncT(String, String, FileDataFormat, String, FuncResponse, T, AsyncHandle)

Lists the fields of a table for a folder connection.

Public methodGetFileTablePreview

Lists the values in a table for a folder connection.

Public methodGetFileTablePreviewAsync(String, String, FileDataFormat, String, AsyncHandle)

Lists the values in a table for a folder connection.

Public methodGetFileTablePreviewAsyncT(String, String, FileDataFormat, String, FuncResponse, T, AsyncHandle)

Lists the values in a table for a folder connection.

Public methodGetFileTables

Lists the tables for a folder connection.

Public methodGetFileTablesAsync(String, String, FileDataFormat, AsyncHandle)

Lists the tables for a folder connection.

Public methodGetFileTablesAsyncT(String, String, FileDataFormat, FuncResponse, T, AsyncHandle)

Lists the tables for a folder connection.

Public methodGetFileTablesEx

Lists the tables and fields of a JSON or XML file for a folder connection.

Public methodGetFileTablesExAsync(String, String, FileDataFormat, AsyncHandle)

Lists the tables and fields of a JSON or XML file for a folder connection.

Public methodGetFileTablesExAsyncT(String, String, FileDataFormat, FuncResponse, T, AsyncHandle)

Lists the tables and fields of a JSON or XML file for a folder connection.

Public methodGetFolderItemsForConnection

Lists the items for a folder connection.

Public methodGetFolderItemsForConnectionAsync(String, String, AsyncHandle)

Lists the items for a folder connection.

Public methodGetFolderItemsForConnectionAsyncT(String, String, FuncResponse, T, AsyncHandle)

Lists the items for a folder connection.

Public methodGetGenericBookmark

Returns the handle of a bookmark.

Public methodGetGenericBookmarkAsync(String, AsyncHandle)

Returns the handle of a bookmark.

Public methodGetGenericBookmarkAsyncT(String, FuncResponse, T, AsyncHandle)

Returns the handle of a bookmark.

Public methodGetGenericDimension

Returns the handle of a dimension if the target (or handle) is app.

Public methodGetGenericDimensionAsync(String, AsyncHandle)

Returns the handle of a dimension if the target (or handle) is app.

Public methodGetGenericDimensionAsyncT(String, FuncResponse, T, AsyncHandle)

Returns the handle of a dimension if the target (or handle) is app.

Public methodGetGenericMeasure

* Returns the definition of a measure if the target (or handle ) is a measure

* Returns the handle of a measure if the target (or handle) is an app

Public methodGetGenericMeasureAsync(String, AsyncHandle)

* Returns the definition of a measure if the target (or handle ) is a measure

* Returns the handle of a measure if the target (or handle) is an app

Public methodGetGenericMeasureAsyncT(String, FuncResponse, T, AsyncHandle)

* Returns the definition of a measure if the target (or handle ) is a measure

* Returns the handle of a measure if the target (or handle) is an app

Public methodGetGenericObject

Returns the type of the app object and the corresponding handle.

Public methodGetGenericObjectAsync(String, AsyncHandle)

Returns the type of the app object and the corresponding handle.

Public methodGetGenericObjectAsyncT(String, FuncResponse, T, AsyncHandle)

Returns the type of the app object and the corresponding handle.

Public methodGetIncludeFileContent

Gets the content of a file.

Public methodGetIncludeFileContentAsync(String, AsyncHandle)

Gets the content of a file.

Public methodGetIncludeFileContentAsyncT(String, FuncResponse, T, AsyncHandle)

Gets the content of a file.

Public methodGetLocaleInfo

Retrieves locale information.

Public methodGetLocaleInfoAsync(AsyncHandle)

Retrieves locale information.

Public methodGetLocaleInfoAsyncT(FuncResponse, T, AsyncHandle)

Retrieves locale information.

Public methodGetLooselyCoupledVector

Returns a vector of loosely coupled state flags, one element for each table in the app.

The last three values in the vector are extra values. These values are for internal use.In case of circular references, the engine automatically create loosely coupled tables so that the circular references do not create a loop.
Public methodGetLooselyCoupledVectorAsync(AsyncHandle)

Returns a vector of loosely coupled state flags, one element for each table in the app.

The last three values in the vector are extra values. These values are for internal use.In case of circular references, the engine automatically create loosely coupled tables so that the circular references do not create a loop.
Public methodGetLooselyCoupledVectorAsyncT(FuncResponse, T, AsyncHandle)

Returns a vector of loosely coupled state flags, one element for each table in the app.

The last three values in the vector are extra values. These values are for internal use.In case of circular references, the engine automatically create loosely coupled tables so that the circular references do not create a loop.
Public methodGetMatchingFields

Retrieves any fields that match all the specified tags in the data model of an app.

Tags set by Qlik Sense are prefixed by the $ sign.
Public methodGetMatchingFieldsAsync(IEnumerableString, NxMatchingFieldMode, AsyncHandle)

Retrieves any fields that match all the specified tags in the data model of an app.

Tags set by Qlik Sense are prefixed by the $ sign.
Public methodGetMatchingFieldsAsyncT(IEnumerableString, NxMatchingFieldMode, FuncResponse, T, AsyncHandle)

Retrieves any fields that match all the specified tags in the data model of an app.

Tags set by Qlik Sense are prefixed by the $ sign.
Public methodGetObjectT(String)
Public methodGetObjectT, TI(String)
Public methodGetObjectAsyncT(String, AsyncHandle)
Public methodGetObjectAsyncT, TI(String, AsyncHandle)
Public methodGetProperties
Public methodGetPropertiesAsync(AsyncHandle)
Public methodGetPropertiesAsyncT(FuncResponse, T, AsyncHandle)
Public methodGetScript

Gets values in script.

Public methodGetScriptAsync(AsyncHandle)

Gets values in script.

Public methodGetScriptAsyncT(FuncResponse, T, AsyncHandle)

Gets values in script.

Public methodGetScriptBreakpoints

Lists the breakpoints in the script of an app.

Public methodGetScriptBreakpointsAsync(AsyncHandle)

Lists the breakpoints in the script of an app.

Public methodGetScriptBreakpointsAsyncT(FuncResponse, T, AsyncHandle)

Lists the breakpoints in the script of an app.

Public methodGetTableData

Retrieves the data of a specific table.

Public methodGetTableDataAsync(Int32, Int32, Boolean, String, AsyncHandle)

Retrieves the data of a specific table.

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

Retrieves the data of a specific table.

Public methodGetTablesAndKeys

Returns:

* the list of tables in an app and the fields inside each table

* the list of key fields

Public methodGetTablesAndKeysAsync(Size, Size, Int32, Boolean, Boolean, AsyncHandle)

Returns:

* the list of tables in an app and the fields inside each table

* the list of key fields

Public methodGetTablesAndKeysAsyncT(Size, Size, Int32, Boolean, Boolean, FuncResponse, T, AsyncHandle)

Returns:

* the list of tables in an app and the fields inside each table

* the list of key fields

Public methodGetTextMacros

Fetches updated variables after a statement execution.

Public methodGetTextMacrosAsync(AsyncHandle)

Fetches updated variables after a statement execution.

Public methodGetTextMacrosAsyncT(FuncResponse, T, AsyncHandle)

Fetches updated variables after a statement execution.

Public methodGetVariable

Gets the handle of a script variable.

Public methodGetVariableAsync(String, AsyncHandle)

Gets the handle of a script variable.

Public methodGetVariableAsyncT(String, FuncResponse, T, AsyncHandle)

Gets the handle of a script variable.

Public methodGetViewDlgSaveInfo

Retrieves information about the position of the tables in the data model viewer.

The position of the broom points and the position of the connection points can not be retrieved in Qlik Sense.

** Representation of tables, broom points and connection points **

The green circles represent the broom points.

The red circle represent a connection point.

Public methodGetViewDlgSaveInfoAsync(AsyncHandle)

Retrieves information about the position of the tables in the data model viewer.

The position of the broom points and the position of the connection points can not be retrieved in Qlik Sense.

** Representation of tables, broom points and connection points **

The green circles represent the broom points.

The red circle represent a connection point.

Public methodGetViewDlgSaveInfoAsyncT(FuncResponse, T, AsyncHandle)

Retrieves information about the position of the tables in the data model viewer.

The position of the broom points and the position of the connection points can not be retrieved in Qlik Sense.

** Representation of tables, broom points and connection points **

The green circles represent the broom points.

The red circle represent a connection point.

Public methodGuessFileType

Guesses the data format for a given file.

Recognized file formats are:

* CSV for Delimited

* FIX for Fixed Record

* DIF for Data Interchange Format

* EXCEL_BIFF for Microsoft Excel (XLS)

* EXCEL_OOXML for Microsoft Excel (XLSX)

* HTMLfor HTML

* QVD for QVD file

* XML for XML

* QVX for QVX file

* JSON for JSON format

* KML for KML file

Public methodGuessFileTypeAsync(String, String, AsyncHandle)

Guesses the data format for a given file.

Recognized file formats are:

* CSV for Delimited

* FIX for Fixed Record

* DIF for Data Interchange Format

* EXCEL_BIFF for Microsoft Excel (XLS)

* EXCEL_OOXML for Microsoft Excel (XLSX)

* HTMLfor HTML

* QVD for QVD file

* XML for XML

* QVX for QVX file

* JSON for JSON format

* KML for KML file

Public methodGuessFileTypeAsyncT(String, String, FuncResponse, T, AsyncHandle)

Guesses the data format for a given file.

Recognized file formats are:

* CSV for Delimited

* FIX for Fixed Record

* DIF for Data Interchange Format

* EXCEL_BIFF for Microsoft Excel (XLS)

* EXCEL_OOXML for Microsoft Excel (XLSX)

* HTMLfor HTML

* QVD for QVD file

* XML for XML

* QVX for QVX file

* JSON for JSON format

* KML for KML file

Public methodLockAll

Locks all selections in all fields of the current app.

Public methodLockAllAsync

Locks all selections in all fields of the current app.

Public methodModifyConnection

Updates a connection.

The identifier of a connection cannot be updated.
Public methodModifyConnectionAsync

Updates a connection.

The identifier of a connection cannot be updated.
Public methodPublish

Publishes an app. The published app can have a different name than the original app. All app objects are published. Generic objects, bookmarks, dimensions and measures inside the app are published.

An app can only be published once and cannot be published to more than one stream.
Public methodPublishAsync

Publishes an app. The published app can have a different name than the original app. All app objects are published. Generic objects, bookmarks, dimensions and measures inside the app are published.

An app can only be published once and cannot be published to more than one stream.
Public methodRedo

Redoes the previous operation.

Public methodRedoAsync(AsyncHandle)

Redoes the previous operation.

Public methodRedoAsyncT(FuncResponse, T, AsyncHandle)

Redoes the previous operation.

Public methodReduceData
Public methodReduceDataAsync
Public methodRemoveAllData
Public methodRemoveAllDataAsync
Public methodRemoveAlternateState

Removes an alternate state in the app.

Public methodRemoveAlternateStateAsync

Removes an alternate state in the app.

Public methodRemoveVariable

Removes a script variable.

Public methodRemoveVariableAsync(String, AsyncHandle)

Removes a script variable.

Public methodRemoveVariableAsyncT(String, FuncResponse, T, AsyncHandle)

Removes a script variable.

Public methodResume

Resumes the app as the user left it.

Public methodResumeAsync

Resumes the app as the user left it.

Public methodSearchAssociations

Searches for one or more terms in the values of an app.

This type of search is the global associative search.
Public methodSearchAssociationsAsync(SearchCombinationOptions, IEnumerableString, SearchPage, AsyncHandle)

Searches for one or more terms in the values of an app.

This type of search is the global associative search.
Public methodSearchAssociationsAsyncT(SearchCombinationOptions, IEnumerableString, SearchPage, FuncResponse, T, AsyncHandle)

Searches for one or more terms in the values of an app.

This type of search is the global associative search.
Public methodSearchSuggest

Returns search suggestions.

Public methodSearchSuggestAsync(SearchCombinationOptions, IEnumerableString, AsyncHandle)

Returns search suggestions.

Public methodSearchSuggestAsyncT(SearchCombinationOptions, IEnumerableString, FuncResponse, T, AsyncHandle)

Returns search suggestions.

Public methodSelectAssociations

Selects all search hits for a specified group.

Public methodSelectAssociationsAsync

Selects all search hits for a specified group.

Public methodSendGenericCommandToCustomConnector

Sends a generic command to a custom connector.

For more information on the commands that can be sent to a custom connector, see the QVX SDK help.

Public methodSendGenericCommandToCustomConnectorAsync(String, String, String, IEnumerableString, String, AsyncHandle)

Sends a generic command to a custom connector.

For more information on the commands that can be sent to a custom connector, see the QVX SDK help.

Public methodSendGenericCommandToCustomConnectorAsyncT(String, String, String, IEnumerableString, String, FuncResponse, T, AsyncHandle)

Sends a generic command to a custom connector.

For more information on the commands that can be sent to a custom connector, see the QVX SDK help.

Public methodSetAppProperties

Sets dynamic properties to an app.

Public methodSetAppPropertiesAsync

Sets dynamic properties to an app.

Public methodSetFavoriteVariables

Set some variables as favorite.

Public methodSetFavoriteVariablesAsync

Set some variables as favorite.

Public methodSetFetchLimit

Limits the number of rows of data to load from a data source.

This method works when reloading in debug mode.

Public methodSetFetchLimitAsync

Limits the number of rows of data to load from a data source.

This method works when reloading in debug mode.

Public methodSetLooselyCoupledVector

Sets a vector of loosely coupled state flags, one element for each table in the app.

The last three values in the vector are extra values. These values are for internal use.
Public methodSetLooselyCoupledVectorAsync(IEnumerableByte, AsyncHandle)

Sets a vector of loosely coupled state flags, one element for each table in the app.

The last three values in the vector are extra values. These values are for internal use.
Public methodSetLooselyCoupledVectorAsyncT(IEnumerableByte, FuncResponse, T, AsyncHandle)

Sets a vector of loosely coupled state flags, one element for each table in the app.

The last three values in the vector are extra values. These values are for internal use.
Public methodSetScript

Sets values in script.

Public methodSetScriptAsync

Sets values in script.

Public methodSetScriptBreakpoints

Set some breakpoints in the script of an app.

Public methodSetScriptBreakpointsAsync

Set some breakpoints in the script of an app.

Public methodSetViewDlgSaveInfo

Sets the positions of the tables in the data model viewer.

The position of the broom points and the position of the connection points can not be set in Qlik Sense.

** Representation of tables, broom points and connection points **

The green circles represent the broom points.

The red circle represent a connection point.

Public methodSetViewDlgSaveInfoAsync

Sets the positions of the tables in the data model viewer.

The position of the broom points and the position of the connection points can not be set in Qlik Sense.

** Representation of tables, broom points and connection points **

The green circles represent the broom points.

The red circle represent a connection point.

Public methodUndo

Undoes the previous operation.

Public methodUndoAsync(AsyncHandle)

Undoes the previous operation.

Public methodUndoAsyncT(FuncResponse, T, AsyncHandle)

Undoes the previous operation.

Public methodUnlockAll

Unlocks all selections in all fields of the current app.

Public methodUnlockAllAsync

Unlocks all selections in all fields of the current app.

Public methodUnPublish

Unpublishes an app.

Public methodUnPublishAsync

Unpublishes an app.

Top
Extension Methods
  NameDescription
Public Extension MethodApplyBookmark
Apply bookmark
(Defined by AppExtensions.)
Public Extension MethodApplyBookmarkAsync
Apply bookmark
(Defined by AppExtensions.)
Public Extension MethodCreateAndLinkMasterObject
Create and link master object, this method will create a master object and will convert the source object to linked object (linked to the created master object).
(Defined by AppExtensions.)
Public Extension MethodCreateAndLinkMasterObjectAsync
Create and link master object, this method will create a master object and will convert the source object to linked object (linked to the created master object).
(Defined by AppExtensions.)
Public Extension MethodCreateBookmark
Create bookmark
(Defined by AppExtensions.)
Public Extension MethodCreateBookmarkAsync
Create bookmark
(Defined by AppExtensions.)
Public Extension MethodCreateDimension(String, DimensionProperties)Overloaded.
Create dimension
(Defined by AppExtensions.)
Public Extension MethodCreateDimension(String, String)Overloaded.
Create dimension
(Defined by AppExtensions.)
Public Extension MethodCreateDimension(String, IEnumerableString)Overloaded.
Create dimension
(Defined by AppExtensions.)
Public Extension MethodCreateDimensionAsync(String, DimensionProperties)Overloaded.
Create dimension
(Defined by AppExtensions.)
Public Extension MethodCreateDimensionAsync(String, String)Overloaded.
Create dimension
(Defined by AppExtensions.)
Public Extension MethodCreateDimensionAsync(String, IEnumerableString)Overloaded.
Create dimension
(Defined by AppExtensions.)
Public Extension MethodCreateMasterObject
Create master object, this method will create a master object from source object.
(Defined by AppExtensions.)
Public Extension MethodCreateMasterObjectAsync
Create master object, this method will create a master object from source object.
(Defined by AppExtensions.)
Public Extension MethodCreateMeasure(String, MeasureProperties)Overloaded.
Create measure
(Defined by AppExtensions.)
Public Extension MethodCreateMeasure(String, String)Overloaded.
Create measure
(Defined by AppExtensions.)
Public Extension MethodCreateMeasureAsync(String, MeasureProperties)Overloaded.
Create measure
(Defined by AppExtensions.)
Public Extension MethodCreateMeasureAsync(String, String)Overloaded.
Create measure
(Defined by AppExtensions.)
Public Extension MethodCreateSheet
Create sheet
(Defined by AppExtensions.)
Public Extension MethodCreateSheetAsync
Create sheet
(Defined by AppExtensions.)
Public Extension MethodCreateSnapshot
Create snapshot
(Defined by AppExtensions.)
Public Extension MethodCreateSnapshotAsync
Create snapshot
(Defined by AppExtensions.)
Public Extension MethodCreateStory
Create story
(Defined by AppExtensions.)
Public Extension MethodCreateStoryAsync
Create story
(Defined by AppExtensions.)
Public Extension MethodDestroyStory
Destroy story
(Defined by AppExtensions.)
Public Extension MethodDestroyStoryAsync
Destroy story
(Defined by AppExtensions.)
Public Extension MethodGetAppField
Get app field
(Defined by AppExtensions.)
Public Extension MethodGetAppFieldAsync
Get app field
(Defined by AppExtensions.)
Public Extension MethodGetAppFields
Get app fields
(Defined by AppExtensions.)
Public Extension MethodGetAppFieldsAsync
Get app fields
(Defined by AppExtensions.)
Public Extension MethodGetBookmark
Get bookmark
(Defined by AppExtensions.)
Public Extension MethodGetBookmarkAsync
Get bookmark
(Defined by AppExtensions.)
Public Extension MethodGetBookmarkList
(Defined by AppExtensions.)
Public Extension MethodGetBookmarkListAsync
(Defined by AppExtensions.)
Public Extension MethodGetCommonOperationsScript (Defined by ScriptExtensions.)
Public Extension MethodGetCurrentSelection
(Defined by AppExtensions.)
Public Extension MethodGetCurrentSelectionAsync
(Defined by AppExtensions.)
Public Extension MethodGetDimension
Get dimension
(Defined by AppExtensions.)
Public Extension MethodGetDimensionAsync
Get dimension
(Defined by AppExtensions.)
Public Extension MethodGetDimensionList
(Defined by AppExtensions.)
Public Extension MethodGetDimensionListAsync
(Defined by AppExtensions.)
Public Extension MethodGetExtendedCurrentSelection
Gets the extended current selections (gives you all the values, not a range as the nornal current selection)
(Defined by SelectionExtensions.)
Public Extension MethodGetExtendedCurrentSelectionAsync
Gets the extended current selections (gives you all the values, not a range as the nornal current selection)
(Defined by SelectionExtensions.)
Public Extension MethodGetExtensionList
(Defined by AppExtensions.)
Public Extension MethodGetExtensionListAsync
(Defined by AppExtensions.)
Public Extension MethodGetFieldList
(Defined by AppExtensions.)
Public Extension MethodGetFieldListAsync
(Defined by AppExtensions.)
Public Extension MethodGetMasterObject
Get master object
(Defined by AppExtensions.)
Public Extension MethodGetMasterObjectAsync
Get master object
(Defined by AppExtensions.)
Public Extension MethodGetMasterObjectList
(Defined by AppExtensions.)
Public Extension MethodGetMasterObjectListAsync
(Defined by AppExtensions.)
Public Extension MethodGetMeasure
Get measure
(Defined by AppExtensions.)
Public Extension MethodGetMeasureAsync
Get measure
(Defined by AppExtensions.)
Public Extension MethodGetMeasureList
(Defined by AppExtensions.)
Public Extension MethodGetMeasureListAsync
(Defined by AppExtensions.)
Public Extension MethodGetSheet
Get sheet
(Defined by AppExtensions.)
Public Extension MethodGetSheetAsync
Get sheet
(Defined by AppExtensions.)
Public Extension MethodGetSheetList
(Defined by AppExtensions.)
Public Extension MethodGetSheetListAsync
(Defined by AppExtensions.)
Public Extension MethodGetSheets
Get sheets
(Defined by AppExtensions.)
Public Extension MethodGetSheetsAsync
Get sheets
(Defined by AppExtensions.)
Public Extension MethodGetSnapshot
Get snapshot
(Defined by AppExtensions.)
Public Extension MethodGetSnapshotAsync
Get snapshot
(Defined by AppExtensions.)
Public Extension MethodGetSnapshotList
(Defined by AppExtensions.)
Public Extension MethodGetSnapshotListAsync
(Defined by AppExtensions.)
Public Extension MethodGetStories
Get stories
(Defined by AppExtensions.)
Public Extension MethodGetStoriesAsync
Get stories
(Defined by AppExtensions.)
Public Extension MethodGetStory
Get story
(Defined by AppExtensions.)
Public Extension MethodGetStoryAsync
Get story
(Defined by AppExtensions.)
Public Extension MethodGetStoryList
(Defined by AppExtensions.)
Public Extension MethodGetStoryListAsync
(Defined by AppExtensions.)
Public Extension MethodGetUndoInfo
(Defined by AppExtensions.)
Public Extension MethodGetUndoInfoAsync
(Defined by AppExtensions.)
Public Extension MethodLinkMasterObject
Link master object, this method will convert the source object to linked object (linked to the master object id).
(Defined by AppExtensions.)
Public Extension MethodLinkMasterObjectAsync
Link master object, this method will convert the source object to linked object (linked to the master object id).
(Defined by AppExtensions.)
Public Extension MethodRemoveBookmark
Remove bookmark
(Defined by AppExtensions.)
Public Extension MethodRemoveBookmarkAsync
Remove bookmark
(Defined by AppExtensions.)
Public Extension MethodRemoveDimension
Remove dimension
(Defined by AppExtensions.)
Public Extension MethodRemoveDimensionAsync
Remove dimension
(Defined by AppExtensions.)
Public Extension MethodRemoveMasterObject
Remove master object, this method will unlink all linked objects and remove the master object.
(Defined by AppExtensions.)
Public Extension MethodRemoveMasterObjectAsync
Remove master object, this method will unlink all linked objects and remove the master object.
(Defined by AppExtensions.)
Public Extension MethodRemoveMeasure
Remove measure
(Defined by AppExtensions.)
Public Extension MethodRemoveMeasureAsync
Remove measure
(Defined by AppExtensions.)
Public Extension MethodRemoveSheet
Remove sheet
(Defined by AppExtensions.)
Public Extension MethodRemoveSheetAsync
Remove sheet
(Defined by AppExtensions.)
Public Extension MethodRemoveSnapshot
Remove snapshot
(Defined by AppExtensions.)
Public Extension MethodRemoveSnapshotAsync
Remove snapshot
(Defined by AppExtensions.)
Public Extension MethodUnlinkMasterObject
Unlink master object, this method will convert the source object to the type of the master object.
(Defined by AppExtensions.)
Public Extension MethodUnlinkMasterObjectAsync
Unlink master object, this method will convert the source object to the type of the master object.
(Defined by AppExtensions.)
Top
Properties
  NameDescription
Public propertyHandle
The handle of the Qlik Sense entity.
(Inherited from IQixClassBase.)
Public propertyId
The id of the Qlik Sense entity.
(Inherited from IQixClassBase.)
Public propertySession
Public propertyType
The type of the Qlik Sense entity.
(Inherited from IQixClassBase.)
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 IQixClassBase.)
Public eventClosed
This event fires when the Qlik Sense entity has been removed or deleted.
(Inherited from IQixClassBase.)
Public eventCommunicationError
Public eventMethodInvocationError
Top
See Also