IApp Interface

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

Public Interface IApp
	Inherits IQixClassBase, IDisposable

The IApp type exposes the following members.

Methods

	Name	Description
	AbortModal	Aborts any selection mode in an app. For more information about selection mode, see BeginSelections method.
	AbortModalAsync	Aborts any selection mode in an app. For more information about selection mode, see BeginSelections method.
	AddAlternateState	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.
	AddAlternateStateAsync	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.
	AddFieldFromExpression	Adds a field on the fly. The expression of a field on the fly is persisted but not its values.
	AddFieldFromExpressionAsync(String, String, AsyncHandle)	Adds a field on the fly. The expression of a field on the fly is persisted but not its values.
	AddFieldFromExpressionAsyncT(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.
	ApplyGenericBookmark	Applies a bookmark.
	ApplyGenericBookmarkAsync(String, AsyncHandle)	Applies a bookmark.
	ApplyGenericBookmarkAsyncT(String, FuncResponse, T, AsyncHandle)	Applies a bookmark.
	AssignDerivedFieldFor
	AssignDerivedFieldForAsync
	Back	Loads the last logical operation (if any).
	BackAsync	Loads the last logical operation (if any).
	BackCount	Returns the number of entries on the Back stack.
	BackCountAsync(AsyncHandle)	Returns the number of entries on the Back stack.
	BackCountAsyncT(FuncResponse, T, AsyncHandle)	Returns the number of entries on the Back stack.
	CheckExpression	Checks if a given expression is valid.
	CheckExpressionAsync(String, IEnumerableString, AsyncHandle)	Checks if a given expression is valid.
	CheckExpressionAsyncT(String, IEnumerableString, FuncResponse, T, AsyncHandle)	Checks if a given expression is valid.
	CheckNumberOrExpression	Checks if: * a given expression is valid * a number is correct according to the locale.
	CheckNumberOrExpressionAsync(String, AsyncHandle)	Checks if: * a given expression is valid * a number is correct according to the locale.
	CheckNumberOrExpressionAsyncT(String, FuncResponse, T, AsyncHandle)	Checks if: * a given expression is valid * a number is correct according to the locale.
	CheckScriptSyntax	Checks the syntax of a script.
	CheckScriptSyntaxAsync(AsyncHandle)	Checks the syntax of a script.
	CheckScriptSyntaxAsyncT(FuncResponse, T, AsyncHandle)	Checks the syntax of a script.
	ClearAll	Clears all selections in all fields of the current app.
	ClearAllAsync	Clears all selections in all fields of the current app.
	ClearUndoBuffer	Clears entirely the undo and redo buffer.
	ClearUndoBufferAsync	Clears entirely the undo and redo buffer.
	CloneGenericBookmark	Clones a bookmark. To clone: * a dimension, use CloneDimension method * a measure, use CloneMeasure method * an object, use CloneObject method
	CloneGenericBookmarkAsync(String, AsyncHandle)	Clones a bookmark. To clone: * a dimension, use CloneDimension method * a measure, use CloneMeasure method * an object, use CloneObject method
	CloneGenericBookmarkAsyncT(String, FuncResponse, T, AsyncHandle)	Clones a bookmark. To clone: * a dimension, use CloneDimension method * a measure, use CloneMeasure method * an object, use CloneObject method
	CloneGenericDimension	Clones a dimension. To clone: * a bookmark, use CloneBookmark method * a measure, use CloneMeasure method * an object, use CloneObject method
	CloneGenericDimensionAsync(String, AsyncHandle)	Clones a dimension. To clone: * a bookmark, use CloneBookmark method * a measure, use CloneMeasure method * an object, use CloneObject method
	CloneGenericDimensionAsyncT(String, FuncResponse, T, AsyncHandle)	Clones a dimension. To clone: * a bookmark, use CloneBookmark method * a measure, use CloneMeasure method * an object, use CloneObject method
	CloneGenericMeasure	Clones a measure. To clone: * a bookmark, use CloneBookmark method * a dimension, use CloneDimension method * an object, use CloneObject method
	CloneGenericMeasureAsync(String, AsyncHandle)	Clones a measure. To clone: * a bookmark, use CloneBookmark method * a dimension, use CloneDimension method * an object, use CloneObject method
	CloneGenericMeasureAsyncT(String, FuncResponse, T, AsyncHandle)	Clones a measure. To clone: * a bookmark, use CloneBookmark method * a dimension, use CloneDimension method * an object, use CloneObject method
	CloneGenericObject	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
	CloneGenericObjectAsync(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
	CloneGenericObjectAsyncT(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
	CommitDraft	Commits the draft of an object that was previously created by invoking the CreateDraft method. Committing a draft replaces the corresponding published object.
	CommitDraftAsync	Commits the draft of an object that was previously created by invoking the CreateDraft method. Committing a draft replaces the corresponding published object.
	CreateConnection	Creates a connection. A connection indicates from which data source, the data should be taken.
	CreateConnectionAsync(Connection, AsyncHandle)	Creates a connection. A connection indicates from which data source, the data should be taken.
	CreateConnectionAsyncT(Connection, FuncResponse, T, AsyncHandle)	Creates a connection. A connection indicates from which data source, the data should be taken.
	CreateDerivedDefinition
	CreateDerivedDefinitionAsync(GenericDerivedDefinitionProperties, AsyncHandle)
	CreateDerivedDefinitionAsyncT(GenericDerivedDefinitionProperties, FuncResponse, T, AsyncHandle)
	CreateDerivedFields
	CreateDerivedFieldsAsync(GenericDerivedFieldsProperties, AsyncHandle)
	CreateDerivedFieldsAsyncT(GenericDerivedFieldsProperties, FuncResponse, T, AsyncHandle)
	CreateDraft	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.
	CreateDraftAsync(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.
	CreateDraftAsyncT(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.
	CreateGenericBookmark	Creates a bookmark.
	CreateGenericBookmarkAsync(GenericBookmarkProperties, AsyncHandle)	Creates a bookmark.
	CreateGenericBookmarkAsyncT(GenericBookmarkProperties, FuncResponse, T, AsyncHandle)	Creates a bookmark.
	CreateGenericDimension	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.
	CreateGenericDimensionAsync(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.
	CreateGenericDimensionAsyncT(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.
	CreateGenericMeasure	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.
	CreateGenericMeasureAsync(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.
	CreateGenericMeasureAsyncT(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.
	CreateGenericObject	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.
	CreateGenericObjectAsync(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.
	CreateGenericObjectAsyncT(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.
	CreateGenericSessionObject	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.
	CreateGenericSessionObjectAsync(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.
	CreateGenericSessionObjectAsyncT(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.
	CreateVariable	Creates a script variable. To set some properties to the variable, use the SetNxProperties method.
	CreateVariableAsync(String, AsyncHandle)	Creates a script variable. To set some properties to the variable, use the SetNxProperties method.
	CreateVariableAsyncT(String, FuncResponse, T, AsyncHandle)	Creates a script variable. To set some properties to the variable, use the SetNxProperties method.
	DeleteConnection	Deletes a connection.
	DeleteConnectionAsync	Deletes a connection.
	DestroyDraft	Removes the draft of an object. The children of the draft object (if any) are removed as well.
	DestroyDraftAsync(String, String, AsyncHandle)	Removes the draft of an object. The children of the draft object (if any) are removed as well.
	DestroyDraftAsyncT(String, String, FuncResponse, T, AsyncHandle)	Removes the draft of an object. The children of the draft object (if any) are removed as well.
	DestroyGenericBookmark	Removes a bookmark.
	DestroyGenericBookmarkAsync(String, AsyncHandle)	Removes a bookmark.
	DestroyGenericBookmarkAsyncT(String, FuncResponse, T, AsyncHandle)	Removes a bookmark.
	DestroyGenericDimension	Removes a dimension.
	DestroyGenericDimensionAsync(String, AsyncHandle)	Removes a dimension.
	DestroyGenericDimensionAsyncT(String, FuncResponse, T, AsyncHandle)	Removes a dimension.
	DestroyGenericMeasure	Removes a generic measure.
	DestroyGenericMeasureAsync(String, AsyncHandle)	Removes a generic measure.
	DestroyGenericMeasureAsyncT(String, FuncResponse, T, AsyncHandle)	Removes a generic measure.
	DestroyGenericObject	Removes an app object. The children of the object (if any) are removed as well.
	DestroyGenericObjectAsync(String, AsyncHandle)	Removes an app object. The children of the object (if any) are removed as well.
	DestroyGenericObjectAsyncT(String, FuncResponse, T, AsyncHandle)	Removes an app object. The children of the object (if any) are removed as well.
	DestroyGenericSessionObject	Removes a transient object.
	DestroyGenericSessionObjectAsync(String, AsyncHandle)	Removes a transient object.
	DestroyGenericSessionObjectAsyncT(String, FuncResponse, T, AsyncHandle)	Removes a transient object.
	DoReload	Reloads the script that is set in an app.
	DoReloadAsync(Int32, Boolean, Boolean, AsyncHandle)	Reloads the script that is set in an app.
	DoReloadAsyncT(Int32, Boolean, Boolean, FuncResponse, T, AsyncHandle)	Reloads the script that is set in an app.
	DoSave	Saves an app. All objects and data in the data model are saved.
	DoSaveAsync	Saves an app. All objects and data in the data model are saved.
	Evaluate
	EvaluateAsync(String, AsyncHandle)
	EvaluateAsyncT(String, FuncResponse, T, AsyncHandle)
	EvaluateEx
	EvaluateExAsync(String, AsyncHandle)
	EvaluateExAsyncT(String, FuncResponse, T, AsyncHandle)
	FindMatchingFields	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.
	FindMatchingFieldsAsync(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.
	FindMatchingFieldsAsyncT(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.
	Forward	Loads the next logical operation (if any).
	ForwardAsync	Loads the next logical operation (if any).
	ForwardCount	Returns the number of entries on the Forward stack.
	ForwardCountAsync(AsyncHandle)	Returns the number of entries on the Forward stack.
	ForwardCountAsyncT(FuncResponse, T, AsyncHandle)	Returns the number of entries on the Forward stack.
	GenerateThumbNail
	GenerateThumbNailAsync(String, AsyncHandle)
	GenerateThumbNailAsyncT(String, FuncResponse, T, AsyncHandle)
	GetAllDerivedFields
	GetAllDerivedFieldsAsync(AsyncHandle)
	GetAllDerivedFieldsAsyncT(FuncResponse, T, AsyncHandle)
	GetAppLayout	Evaluates an app. Returns dynamic properties (if any) in addition to the engine (fixed) properties.
	GetAppLayoutAsync(AsyncHandle)	Evaluates an app. Returns dynamic properties (if any) in addition to the engine (fixed) properties.
	GetAppLayoutAsyncT(FuncResponse, T, AsyncHandle)	Evaluates an app. Returns dynamic properties (if any) in addition to the engine (fixed) properties.
	GetAppProperties	Gets the dynamic properties of an app.
	GetAppPropertiesAsync(AsyncHandle)	Gets the dynamic properties of an app.
	GetAppPropertiesAsyncT(FuncResponse, T, AsyncHandle)	Gets the dynamic properties of an app.
	GetConnection	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
	GetConnectionAsync(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
	GetConnectionAsyncT(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
	GetConnections	Lists the connections in an app.
	GetConnectionsAsync(AsyncHandle)	Lists the connections in an app.
	GetConnectionsAsyncT(FuncResponse, T, AsyncHandle)	Lists the connections in an app.
	GetDatabaseInfo	Gives information about an ODBC, OLEDB or CUSTOM connection. See Outputs for more details.
	GetDatabaseInfoAsync(String, AsyncHandle)	Gives information about an ODBC, OLEDB or CUSTOM connection. See Outputs for more details.
	GetDatabaseInfoAsyncT(String, FuncResponse, T, AsyncHandle)	Gives information about an ODBC, OLEDB or CUSTOM connection. See Outputs for more details.
	GetDatabaseOwners	Lists the owners of a database for a ODBC, OLEDB or CUSTOM connection.
	GetDatabaseOwnersAsync(String, String, AsyncHandle)	Lists the owners of a database for a ODBC, OLEDB or CUSTOM connection.
	GetDatabaseOwnersAsyncT(String, String, FuncResponse, T, AsyncHandle)	Lists the owners of a database for a ODBC, OLEDB or CUSTOM connection.
	GetDatabases	Lists the databases inside a ODBC, OLEDB or CUSTOM data source.
	GetDatabasesAsync(String, AsyncHandle)	Lists the databases inside a ODBC, OLEDB or CUSTOM data source.
	GetDatabasesAsyncT(String, FuncResponse, T, AsyncHandle)	Lists the databases inside a ODBC, OLEDB or CUSTOM data source.
	GetDatabaseTableFields	Lists the fields inside a table of a database for a ODBC, OLEDB or CUSTOM connection.
	GetDatabaseTableFieldsAsync(String, String, String, String, AsyncHandle)	Lists the fields inside a table of a database for a ODBC, OLEDB or CUSTOM connection.
	GetDatabaseTableFieldsAsyncT(String, String, String, String, FuncResponse, T, AsyncHandle)	Lists the fields inside a table of a database for a ODBC, OLEDB or CUSTOM connection.
	GetDatabaseTablePreview	Retrieves the values of the specified table of a database for a ODBC, OLEDB or CUSTOM connection.
	GetDatabaseTablePreviewAsync(String, String, String, String, AsyncHandle)	Retrieves the values of the specified table of a database for a ODBC, OLEDB or CUSTOM connection.
	GetDatabaseTablePreviewAsyncT(String, String, String, String, FuncResponse, T, AsyncHandle)	Retrieves the values of the specified table of a database for a ODBC, OLEDB or CUSTOM connection.
	GetDatabaseTables	Lists the tables inside a database for a ODBC, OLEDB or CUSTOM connection.
	GetDatabaseTablesAsync(String, String, String, AsyncHandle)	Lists the tables inside a database for a ODBC, OLEDB or CUSTOM connection.
	GetDatabaseTablesAsyncT(String, String, String, FuncResponse, T, AsyncHandle)	Lists the tables inside a database for a ODBC, OLEDB or CUSTOM connection.
	GetDerivedDefinitionByName
	GetDerivedDefinitionByNameAsync(String, AsyncHandle)
	GetDerivedDefinitionByNameAsyncT(String, FuncResponse, T, AsyncHandle)
	GetDerivedFields
	GetDerivedFieldsAsync(String, AsyncHandle)
	GetDerivedFieldsAsyncT(String, FuncResponse, T, AsyncHandle)
	GetEmptyScript	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.
	GetEmptyScriptAsync(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.
	GetEmptyScriptAsyncT(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.
	GetFavoriteVariables	Retrieves the variables that are tagged as favorite.
	GetFavoriteVariablesAsync(AsyncHandle)	Retrieves the variables that are tagged as favorite.
	GetFavoriteVariablesAsyncT(FuncResponse, T, AsyncHandle)	Retrieves the variables that are tagged as favorite.
	GetField	Retrieves the handle of a field.
	GetFieldAsync(String, String, AsyncHandle)	Retrieves the handle of a field.
	GetFieldAsyncT(String, String, FuncResponse, T, AsyncHandle)	Retrieves the handle of a field.
	GetFieldDescription	Retrieves the description of a field.
	GetFieldDescriptionAsync(String, AsyncHandle)	Retrieves the description of a field.
	GetFieldDescriptionAsyncT(String, FuncResponse, T, AsyncHandle)	Retrieves the description of a field.
	GetFileTableFields	Lists the fields of a table for a folder connection.
	GetFileTableFieldsAsync(String, String, FileDataFormat, String, AsyncHandle)	Lists the fields of a table for a folder connection.
	GetFileTableFieldsAsyncT(String, String, FileDataFormat, String, FuncResponse, T, AsyncHandle)	Lists the fields of a table for a folder connection.
	GetFileTablePreview	Lists the values in a table for a folder connection.
	GetFileTablePreviewAsync(String, String, FileDataFormat, String, AsyncHandle)	Lists the values in a table for a folder connection.
	GetFileTablePreviewAsyncT(String, String, FileDataFormat, String, FuncResponse, T, AsyncHandle)	Lists the values in a table for a folder connection.
	GetFileTables	Lists the tables for a folder connection.
	GetFileTablesAsync(String, String, FileDataFormat, AsyncHandle)	Lists the tables for a folder connection.
	GetFileTablesAsyncT(String, String, FileDataFormat, FuncResponse, T, AsyncHandle)	Lists the tables for a folder connection.
	GetFileTablesEx	Lists the tables and fields of a JSON or XML file for a folder connection.
	GetFileTablesExAsync(String, String, FileDataFormat, AsyncHandle)	Lists the tables and fields of a JSON or XML file for a folder connection.
	GetFileTablesExAsyncT(String, String, FileDataFormat, FuncResponse, T, AsyncHandle)	Lists the tables and fields of a JSON or XML file for a folder connection.
	GetFolderItemsForConnection	Lists the items for a folder connection.
	GetFolderItemsForConnectionAsync(String, String, AsyncHandle)	Lists the items for a folder connection.
	GetFolderItemsForConnectionAsyncT(String, String, FuncResponse, T, AsyncHandle)	Lists the items for a folder connection.
	GetGenericBookmark	Returns the handle of a bookmark.
	GetGenericBookmarkAsync(String, AsyncHandle)	Returns the handle of a bookmark.
	GetGenericBookmarkAsyncT(String, FuncResponse, T, AsyncHandle)	Returns the handle of a bookmark.
	GetGenericDimension	Returns the handle of a dimension if the target (or handle) is app.
	GetGenericDimensionAsync(String, AsyncHandle)	Returns the handle of a dimension if the target (or handle) is app.
	GetGenericDimensionAsyncT(String, FuncResponse, T, AsyncHandle)	Returns the handle of a dimension if the target (or handle) is app.
	GetGenericMeasure	* 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
	GetGenericMeasureAsync(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
	GetGenericMeasureAsyncT(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
	GetGenericObject	Returns the type of the app object and the corresponding handle.
	GetGenericObjectAsync(String, AsyncHandle)	Returns the type of the app object and the corresponding handle.
	GetGenericObjectAsyncT(String, FuncResponse, T, AsyncHandle)	Returns the type of the app object and the corresponding handle.
	GetIncludeFileContent	Gets the content of a file.
	GetIncludeFileContentAsync(String, AsyncHandle)	Gets the content of a file.
	GetIncludeFileContentAsyncT(String, FuncResponse, T, AsyncHandle)	Gets the content of a file.
	GetLocaleInfo	Retrieves locale information.
	GetLocaleInfoAsync(AsyncHandle)	Retrieves locale information.
	GetLocaleInfoAsyncT(FuncResponse, T, AsyncHandle)	Retrieves locale information.
	GetLooselyCoupledVector	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.
	GetLooselyCoupledVectorAsync(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.
	GetLooselyCoupledVectorAsyncT(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.
	GetMatchingFields	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.
	GetMatchingFieldsAsync(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.
	GetMatchingFieldsAsyncT(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.
	GetObjectT(String)
	GetObjectT, TI(String)
	GetObjectAsyncT(String, AsyncHandle)
	GetObjectAsyncT, TI(String, AsyncHandle)
	GetProperties
	GetPropertiesAsync(AsyncHandle)
	GetPropertiesAsyncT(FuncResponse, T, AsyncHandle)
	GetScript	Gets values in script.
	GetScriptAsync(AsyncHandle)	Gets values in script.
	GetScriptAsyncT(FuncResponse, T, AsyncHandle)	Gets values in script.
	GetScriptBreakpoints	Lists the breakpoints in the script of an app.
	GetScriptBreakpointsAsync(AsyncHandle)	Lists the breakpoints in the script of an app.
	GetScriptBreakpointsAsyncT(FuncResponse, T, AsyncHandle)	Lists the breakpoints in the script of an app.
	GetTableData	Retrieves the data of a specific table.
	GetTableDataAsync(Int32, Int32, Boolean, String, AsyncHandle)	Retrieves the data of a specific table.
	GetTableDataAsyncT(Int32, Int32, Boolean, String, FuncResponse, T, AsyncHandle)	Retrieves the data of a specific table.
	GetTablesAndKeys	Returns: * the list of tables in an app and the fields inside each table * the list of key fields
	GetTablesAndKeysAsync(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
	GetTablesAndKeysAsyncT(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
	GetTextMacros	Fetches updated variables after a statement execution.
	GetTextMacrosAsync(AsyncHandle)	Fetches updated variables after a statement execution.
	GetTextMacrosAsyncT(FuncResponse, T, AsyncHandle)	Fetches updated variables after a statement execution.
	GetVariable	Gets the handle of a script variable.
	GetVariableAsync(String, AsyncHandle)	Gets the handle of a script variable.
	GetVariableAsyncT(String, FuncResponse, T, AsyncHandle)	Gets the handle of a script variable.
	GetViewDlgSaveInfo	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.
	GetViewDlgSaveInfoAsync(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.
	GetViewDlgSaveInfoAsyncT(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.
	GuessFileType	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
	GuessFileTypeAsync(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
	GuessFileTypeAsyncT(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
	LockAll	Locks all selections in all fields of the current app.
	LockAllAsync	Locks all selections in all fields of the current app.
	ModifyConnection	Updates a connection. The identifier of a connection cannot be updated.
	ModifyConnectionAsync	Updates a connection. The identifier of a connection cannot be updated.
	Publish	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.
	PublishAsync	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.
	Redo	Redoes the previous operation.
	RedoAsync(AsyncHandle)	Redoes the previous operation.
	RedoAsyncT(FuncResponse, T, AsyncHandle)	Redoes the previous operation.
	ReduceData
	ReduceDataAsync
	RemoveAllData
	RemoveAllDataAsync
	RemoveAlternateState	Removes an alternate state in the app.
	RemoveAlternateStateAsync	Removes an alternate state in the app.
	RemoveVariable	Removes a script variable.
	RemoveVariableAsync(String, AsyncHandle)	Removes a script variable.
	RemoveVariableAsyncT(String, FuncResponse, T, AsyncHandle)	Removes a script variable.
	Resume	Resumes the app as the user left it.
	ResumeAsync	Resumes the app as the user left it.
	SearchAssociations	Searches for one or more terms in the values of an app. This type of search is the global associative search.
	SearchAssociationsAsync(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.
	SearchAssociationsAsyncT(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.
	SearchSuggest	Returns search suggestions.
	SearchSuggestAsync(SearchCombinationOptions, IEnumerableString, AsyncHandle)	Returns search suggestions.
	SearchSuggestAsyncT(SearchCombinationOptions, IEnumerableString, FuncResponse, T, AsyncHandle)	Returns search suggestions.
	SelectAssociations	Selects all search hits for a specified group.
	SelectAssociationsAsync	Selects all search hits for a specified group.
	SendGenericCommandToCustomConnector	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.
	SendGenericCommandToCustomConnectorAsync(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.
	SendGenericCommandToCustomConnectorAsyncT(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.
	SetAppProperties	Sets dynamic properties to an app.
	SetAppPropertiesAsync	Sets dynamic properties to an app.
	SetFavoriteVariables	Set some variables as favorite.
	SetFavoriteVariablesAsync	Set some variables as favorite.
	SetFetchLimit	Limits the number of rows of data to load from a data source. This method works when reloading in debug mode.
	SetFetchLimitAsync	Limits the number of rows of data to load from a data source. This method works when reloading in debug mode.
	SetLooselyCoupledVector	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.
	SetLooselyCoupledVectorAsync(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.
	SetLooselyCoupledVectorAsyncT(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.
	SetScript	Sets values in script.
	SetScriptAsync	Sets values in script.
	SetScriptBreakpoints	Set some breakpoints in the script of an app.
	SetScriptBreakpointsAsync	Set some breakpoints in the script of an app.
	SetViewDlgSaveInfo	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.
	SetViewDlgSaveInfoAsync	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.
	Undo	Undoes the previous operation.
	UndoAsync(AsyncHandle)	Undoes the previous operation.
	UndoAsyncT(FuncResponse, T, AsyncHandle)	Undoes the previous operation.
	UnlockAll	Unlocks all selections in all fields of the current app.
	UnlockAllAsync	Unlocks all selections in all fields of the current app.
	UnPublish	Unpublishes an app.
	UnPublishAsync	Unpublishes an app.

Top

Extension Methods

	Name	Description
	ApplyBookmark	Apply bookmark (Defined by AppExtensions.)
	ApplyBookmarkAsync	Apply bookmark (Defined by AppExtensions.)
	CreateAndLinkMasterObject	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.)
	CreateAndLinkMasterObjectAsync	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.)
	CreateBookmark	Create bookmark (Defined by AppExtensions.)
	CreateBookmarkAsync	Create bookmark (Defined by AppExtensions.)
	CreateDimension(String, DimensionProperties)	Overloaded. Create dimension (Defined by AppExtensions.)
	CreateDimension(String, String)	Overloaded. Create dimension (Defined by AppExtensions.)
	CreateDimension(String, IEnumerableString)	Overloaded. Create dimension (Defined by AppExtensions.)
	CreateDimensionAsync(String, DimensionProperties)	Overloaded. Create dimension (Defined by AppExtensions.)
	CreateDimensionAsync(String, String)	Overloaded. Create dimension (Defined by AppExtensions.)
	CreateDimensionAsync(String, IEnumerableString)	Overloaded. Create dimension (Defined by AppExtensions.)
	CreateMasterObject	Create master object, this method will create a master object from source object. (Defined by AppExtensions.)
	CreateMasterObjectAsync	Create master object, this method will create a master object from source object. (Defined by AppExtensions.)
	CreateMeasure(String, MeasureProperties)	Overloaded. Create measure (Defined by AppExtensions.)
	CreateMeasure(String, String)	Overloaded. Create measure (Defined by AppExtensions.)
	CreateMeasureAsync(String, MeasureProperties)	Overloaded. Create measure (Defined by AppExtensions.)
	CreateMeasureAsync(String, String)	Overloaded. Create measure (Defined by AppExtensions.)
	CreateSheet	Create sheet (Defined by AppExtensions.)
	CreateSheetAsync	Create sheet (Defined by AppExtensions.)
	CreateSnapshot	Create snapshot (Defined by AppExtensions.)
	CreateSnapshotAsync	Create snapshot (Defined by AppExtensions.)
	CreateStory	Create story (Defined by AppExtensions.)
	CreateStoryAsync	Create story (Defined by AppExtensions.)
	DestroyStory	Destroy story (Defined by AppExtensions.)
	DestroyStoryAsync	Destroy story (Defined by AppExtensions.)
	GetAppField	Get app field (Defined by AppExtensions.)
	GetAppFieldAsync	Get app field (Defined by AppExtensions.)
	GetAppFields	Get app fields (Defined by AppExtensions.)
	GetAppFieldsAsync	Get app fields (Defined by AppExtensions.)
	GetBookmark	Get bookmark (Defined by AppExtensions.)
	GetBookmarkAsync	Get bookmark (Defined by AppExtensions.)
	GetBookmarkList	(Defined by AppExtensions.)
	GetBookmarkListAsync	(Defined by AppExtensions.)
	GetCommonOperationsScript	(Defined by ScriptExtensions.)
	GetCurrentSelection	(Defined by AppExtensions.)
	GetCurrentSelectionAsync	(Defined by AppExtensions.)
	GetDimension	Get dimension (Defined by AppExtensions.)
	GetDimensionAsync	Get dimension (Defined by AppExtensions.)
	GetDimensionList	(Defined by AppExtensions.)
	GetDimensionListAsync	(Defined by AppExtensions.)
	GetExtendedCurrentSelection	Gets the extended current selections (gives you all the values, not a range as the nornal current selection) (Defined by SelectionExtensions.)
	GetExtendedCurrentSelectionAsync	Gets the extended current selections (gives you all the values, not a range as the nornal current selection) (Defined by SelectionExtensions.)
	GetExtensionList	(Defined by AppExtensions.)
	GetExtensionListAsync	(Defined by AppExtensions.)
	GetFieldList	(Defined by AppExtensions.)
	GetFieldListAsync	(Defined by AppExtensions.)
	GetMasterObject	Get master object (Defined by AppExtensions.)
	GetMasterObjectAsync	Get master object (Defined by AppExtensions.)
	GetMasterObjectList	(Defined by AppExtensions.)
	GetMasterObjectListAsync	(Defined by AppExtensions.)
	GetMeasure	Get measure (Defined by AppExtensions.)
	GetMeasureAsync	Get measure (Defined by AppExtensions.)
	GetMeasureList	(Defined by AppExtensions.)
	GetMeasureListAsync	(Defined by AppExtensions.)
	GetSheet	Get sheet (Defined by AppExtensions.)
	GetSheetAsync	Get sheet (Defined by AppExtensions.)
	GetSheetList	(Defined by AppExtensions.)
	GetSheetListAsync	(Defined by AppExtensions.)
	GetSheets	Get sheets (Defined by AppExtensions.)
	GetSheetsAsync	Get sheets (Defined by AppExtensions.)
	GetSnapshot	Get snapshot (Defined by AppExtensions.)
	GetSnapshotAsync	Get snapshot (Defined by AppExtensions.)
	GetSnapshotList	(Defined by AppExtensions.)
	GetSnapshotListAsync	(Defined by AppExtensions.)
	GetStories	Get stories (Defined by AppExtensions.)
	GetStoriesAsync	Get stories (Defined by AppExtensions.)
	GetStory	Get story (Defined by AppExtensions.)
	GetStoryAsync	Get story (Defined by AppExtensions.)
	GetStoryList	(Defined by AppExtensions.)
	GetStoryListAsync	(Defined by AppExtensions.)
	GetUndoInfo	(Defined by AppExtensions.)
	GetUndoInfoAsync	(Defined by AppExtensions.)
	LinkMasterObject	Link master object, this method will convert the source object to linked object (linked to the master object id). (Defined by AppExtensions.)
	LinkMasterObjectAsync	Link master object, this method will convert the source object to linked object (linked to the master object id). (Defined by AppExtensions.)
	RemoveBookmark	Remove bookmark (Defined by AppExtensions.)
	RemoveBookmarkAsync	Remove bookmark (Defined by AppExtensions.)
	RemoveDimension	Remove dimension (Defined by AppExtensions.)
	RemoveDimensionAsync	Remove dimension (Defined by AppExtensions.)
	RemoveMasterObject	Remove master object, this method will unlink all linked objects and remove the master object. (Defined by AppExtensions.)
	RemoveMasterObjectAsync	Remove master object, this method will unlink all linked objects and remove the master object. (Defined by AppExtensions.)
	RemoveMeasure	Remove measure (Defined by AppExtensions.)
	RemoveMeasureAsync	Remove measure (Defined by AppExtensions.)
	RemoveSheet	Remove sheet (Defined by AppExtensions.)
	RemoveSheetAsync	Remove sheet (Defined by AppExtensions.)
	RemoveSnapshot	Remove snapshot (Defined by AppExtensions.)
	RemoveSnapshotAsync	Remove snapshot (Defined by AppExtensions.)
	UnlinkMasterObject	Unlink master object, this method will convert the source object to the type of the master object. (Defined by AppExtensions.)
	UnlinkMasterObjectAsync	Unlink master object, this method will convert the source object to the type of the master object. (Defined by AppExtensions.)

Top

Properties

	Name	Description
	Handle	The handle of the Qlik Sense entity. (Inherited from IQixClassBase.)
	Id	The id of the Qlik Sense entity. (Inherited from IQixClassBase.)
	Session
	Type	The type of the Qlik Sense entity. (Inherited from IQixClassBase.)

Top

Events

	Name	Description
	Changed	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.)
	Closed	This event fires when the Qlik Sense entity has been removed or deleted. (Inherited from IQixClassBase.)
	CommunicationError
	MethodInvocationError

Top

Reference

Qlik.Engine Namespace