App MembersQlik Sense .NET SDK - API Reference
The App type exposes the following members.
Constructors

  NameDescription
Public methodApp
Initializes a new instance of the App class
Back to Top
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.

Public methodAddAlternateStateAsync

Adds an alternate state in the app.

Public methodAddFieldFromExpression

Adds a field on the fly.

The field is added in the database model but the change is not persistent. If the app is closed, the field added on the fly does no longer exist.
Public methodAddFieldFromExpressionAsync(String, String, String)

Adds a field on the fly.

The field is added in the database model but the change is not persistent. If the app is closed, the field added on the fly does no longer exist.
Public methodAddFieldFromExpressionAsync T (String, String, Func Response, T , String)

Adds a field on the fly.

The field is added in the database model but the change is not persistent. If the app is closed, the field added on the fly does no longer exist.
Public methodApplyGenericBookmark

Applies a bookmark.

Public methodApplyGenericBookmarkAsync(String, String)

Applies a bookmark.

Public methodApplyGenericBookmarkAsync T (String, Func Response, T , String)

Applies a bookmark.

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(String)

Returns the number of entries on the Back stack.

Public methodBackCountAsync T (Func Response, T , String)

Returns the number of entries on the Back stack.

Public methodCheckExpression

Checks a given expression.

Public methodCheckExpressionAsync(String, IEnumerable String , String)

Checks a given expression.

Public methodCheckExpressionAsync T (String, IEnumerable String , Func Response, T , String)

Checks a given expression.

Public methodCheckScriptSyntax

Checks the syntax of a script.

Public methodCheckScriptSyntaxAsync(String)

Checks the syntax of a script.

Public methodCheckScriptSyntaxAsync T (Func Response, T , String)

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, String)

Clones a bookmark.

To clone:

* a dimension, use CloneDimension method

* a measure, use CloneMeasure method

* an object, use CloneObject method

Public methodCloneGenericBookmarkAsync T (String, Func Response, T , String)

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, String)

Clones a dimension.

To clone:

* a bookmark, use CloneBookmark method

* a measure, use CloneMeasure method

* an object, use CloneObject method

Public methodCloneGenericDimensionAsync T (String, Func Response, T , String)

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, String)

Clones a measure.

To clone:

* a bookmark, use CloneBookmark method

* a dimension, use CloneDimension method

* an object, use CloneObject method

Public methodCloneGenericMeasureAsync T (String, Func Response, T , String)

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, String)

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 T (String, Func Response, T , String)

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
Public methodCommitDraftAsync
Public methodCreateConnection

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

Public methodCreateConnectionAsync(Connection, String)

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

Public methodCreateConnectionAsync T (Connection, Func Response, T , String)

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

Public methodCreateDraft
Public methodCreateDraftAsync(String, String)
Public methodCreateDraftAsync T (String, Func Response, T , String)
Public methodCreateGenericBookmark

Creates a bookmark.

Public methodCreateGenericBookmarkAsync(GenericBookmarkProperties, String)

Creates a bookmark.

Public methodCreateGenericBookmarkAsync T (GenericBookmarkProperties, Func Response, T , String)

Creates a bookmark.

Public methodCreateGenericDimension

Creates a dimension.

Public methodCreateGenericDimensionAsync(GenericDimensionProperties, String)

Creates a dimension.

Public methodCreateGenericDimensionAsync T (GenericDimensionProperties, Func Response, T , String)

Creates a dimension.

Public methodCreateGenericMeasure

Creates a measure.

Public methodCreateGenericMeasureAsync(GenericMeasureProperties, String)

Creates a measure.

Public methodCreateGenericMeasureAsync T (GenericMeasureProperties, Func Response, T , String)

Creates a 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. The linked object has the same properties as the linking object.

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

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. The linked object has the same properties as the linking object.

The linking object cannot be a transient object.
Public methodCreateGenericObjectAsync T (GenericObjectProperties, Func Response, T , String)

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. 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. The linked object has the same properties as the linking object.

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

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. The linked object has the same properties as the linking object.

The linking object cannot be a transient object.
Public methodCreateGenericSessionObjectAsync T (GenericObjectProperties, Func Response, T , String)

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. 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, String)

Creates a script variable.

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

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 methodDestroyGenericBookmark

Removes a bookmark.

Public methodDestroyGenericBookmarkAsync(String, String)

Removes a bookmark.

Public methodDestroyGenericBookmarkAsync T (String, Func Response, T , String)

Removes a bookmark.

Public methodDestroyGenericDimension

Removes a dimension.

Public methodDestroyGenericDimensionAsync(String, String)

Removes a dimension.

Public methodDestroyGenericDimensionAsync T (String, Func Response, T , String)

Removes a dimension.

Public methodDestroyGenericMeasure

Removes a generic measure.

Public methodDestroyGenericMeasureAsync(String, String)

Removes a generic measure.

Public methodDestroyGenericMeasureAsync T (String, Func Response, T , String)

Removes a generic measure.

Public methodDestroyGenericObject

Removes an app object.

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

Public methodDestroyGenericObjectAsync(String, String)

Removes an app object.

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

Public methodDestroyGenericObjectAsync T (String, Func Response, T , String)

Removes an app object.

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

Public methodDestroyGenericSessionObject

Removes a transient object.

Public methodDestroyGenericSessionObjectAsync(String, String)

Removes a transient object.

Public methodDestroyGenericSessionObjectAsync T (String, Func Response, T , String)

Removes a transient object.

Public methodDispose
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
(Inherited from QixClassBase.)
Public methodDoReload

Reloads the script that is set in an app.

Public methodDoReloadAsync(Int32, Boolean, Boolean, String)

Reloads the script that is set in an app.

Public methodDoReloadAsync T (Int32, Boolean, Boolean, Func Response, T , String)

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, String)
Public methodEvaluateAsync T (String, Func Response, T , String)
Public methodEvaluateEx
Public methodEvaluateExAsync(String, String)
Public methodEvaluateExAsync T (String, Func Response, T , String)
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, IEnumerable String , String)

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 T (String, IEnumerable String , Func Response, T , String)

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(String)

Returns the number of entries on the Forward stack.

Public methodForwardCountAsync T (Func Response, T , String)

Returns the number of entries on the Forward stack.

Public methodGenerateThumbNail
Public methodGenerateThumbNailAsync(String, String)
Public methodGenerateThumbNailAsync T (String, Func Response, T , String)
Public methodGetAppLayout

Evaluates an app.

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

Public methodGetAppLayoutAsync(String)

Evaluates an app.

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

Public methodGetAppLayoutAsync T (Func Response, T , String)

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(String)

Gets the dynamic properties of an app.

Public methodGetAppPropertiesAsync T (Func Response, T , String)

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, String)

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 T (String, Func Response, T , String)

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(String)

Lists the connections in an app.

Public methodGetConnectionsAsync T (Func Response, T , String)

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, String)

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

Public methodGetDatabaseInfoAsync T (String, Func Response, T , String)

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, String)

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

Public methodGetDatabaseOwnersAsync T (String, String, Func Response, T , String)

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, String)

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

Public methodGetDatabasesAsync T (String, Func Response, T , String)

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, String)

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

Public methodGetDatabaseTableFieldsAsync T (String, String, String, String, Func Response, T , String)

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, String)

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

Public methodGetDatabaseTablePreviewAsync T (String, String, String, String, Func Response, T , String)

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, String)

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

Public methodGetDatabaseTablesAsync T (String, String, String, Func Response, T , String)

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

Public methodGetDocBookmarkInfo
Public methodGetDocBookmarkInfoAsync(String)
Public methodGetDocBookmarkInfoAsync T (Func Response, T , String)
Public methodGetEmptyScript
Public methodGetEmptyScriptAsync(String, String)
Public methodGetEmptyScriptAsync T (String, Func Response, T , String)
Public methodGetFavoriteVariables

Retrieves the variables that are tagged as favorite.

Public methodGetFavoriteVariablesAsync(String)

Retrieves the variables that are tagged as favorite.

Public methodGetFavoriteVariablesAsync T (Func Response, T , String)

Retrieves the variables that are tagged as favorite.

Public methodGetField

Retrieves the handle of a field.

Public methodGetFieldAsync(String, String, String)

Retrieves the handle of a field.

Public methodGetFieldAsync T (String, String, Func Response, T , String)

Retrieves the handle of a field.

Public methodGetFieldDescription

Retrieves the description of a field.

Public methodGetFieldDescriptionAsync(String, String)

Retrieves the description of a field.

Public methodGetFieldDescriptionAsync T (String, Func Response, T , String)

Retrieves the description of a field.

Public methodGetFileTableFields

Lists the fields of a table for a folder connection.

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

Lists the fields of a table for a folder connection.

Public methodGetFileTableFieldsAsync T (String, String, FileDataFormat, String, Func Response, T , String)

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, String)

Lists the values in a table for a folder connection.

Public methodGetFileTablePreviewAsync T (String, String, FileDataFormat, String, Func Response, T , String)

Lists the values in a table for a folder connection.

Public methodGetFileTables

Lists the tables for a folder connection.

Public methodGetFileTablesAsync(String, String, FileDataFormat, String)

Lists the tables for a folder connection.

Public methodGetFileTablesAsync T (String, String, FileDataFormat, Func Response, T , String)

Lists the tables for a folder connection.

Public methodGetFileTablesEx
Public methodGetFileTablesExAsync(String, String, FileDataFormat, String)
Public methodGetFileTablesExAsync T (String, String, FileDataFormat, Func Response, T , String)
Public methodGetFolderItemsForConnection

Lists the items for a folder connection.

Public methodGetFolderItemsForConnectionAsync(String, String, String)

Lists the items for a folder connection.

Public methodGetFolderItemsForConnectionAsync T (String, String, Func Response, T , String)

Lists the items for a folder connection.

Public methodGetGenericBookmark

Returns the handle of a bookmark.

Public methodGetGenericBookmarkAsync(String, String)

Returns the handle of a bookmark.

Public methodGetGenericBookmarkAsync T (String, Func Response, T , String)

Returns the handle of a bookmark.

Public methodGetGenericDimension

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

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

Public methodGetGenericDimensionAsync(String, String)

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

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

Public methodGetGenericDimensionAsync T (String, Func Response, T , String)

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

* 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, String)

* 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 T (String, Func Response, T , String)

* 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, String)

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

Public methodGetGenericObjectAsync T (String, Func Response, T , String)

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

Public methodGetIncludeFileContent

Gets the content of a file.

Public methodGetIncludeFileContentAsync(String, String)

Gets the content of a file.

Public methodGetIncludeFileContentAsync T (String, Func Response, T , String)

Gets the content of a file.

Public methodGetLocaleInfo

Retrieves information about locale.

Public methodGetLocaleInfoAsync(String)

Retrieves information about locale.

Public methodGetLocaleInfoAsync T (Func Response, T , String)

Retrieves information about locale.

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(String)

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 T (Func Response, T , String)

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(IEnumerable String , String)

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 T (IEnumerable String , Func Response, T , String)

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 methodGetObject T (String)
Get an object
Public methodGetObject T, TI (String)
Get an object
Public methodGetObjectAsync T (String, String)
Get an object
Public methodGetObjectAsync T, TI (String, String)
Get an object
Public methodGetProperties
Public methodGetPropertiesAsync(String)
Public methodGetPropertiesAsync T (Func Response, T , String)
Public methodGetScript

Gets values in script.

Public methodGetScriptAsync(String)

Gets values in script.

Public methodGetScriptAsync T (Func Response, T , String)

Gets values in script.

Public methodGetScriptBreakpoints

Lists the breakpoints in the script of an app.

Public methodGetScriptBreakpointsAsync(String)

Lists the breakpoints in the script of an app.

Public methodGetScriptBreakpointsAsync T (Func Response, T , String)

Lists the breakpoints in the script of an app.

Public methodGetTableData

Retrieves the data of a specific table.

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

Retrieves the data of a specific table.

Public methodGetTableDataAsync T (Int32, Int32, Boolean, String, Func Response, T , String)

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, String)

Returns:

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

* the list of key fields

Public methodGetTablesAndKeysAsync T (Size, Size, Int32, Boolean, Boolean, Func Response, T , String)

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(String)

Fetches updated variables after a statement execution.

Public methodGetTextMacrosAsync T (Func Response, T , String)

Fetches updated variables after a statement execution.

Public methodGetVariable

Gets the handle of a script variable.

Public methodGetVariableAsync(String, String)

Gets the handle of a script variable.

Public methodGetVariableAsync T (String, Func Response, T , String)

Gets the handle of a script variable.

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, String)

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 T (String, String, Func Response, T , String)

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(String)

Redoes the previous operation.

Public methodRedoAsync T (Func Response, T , String)

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, String)

Removes a script variable.

Public methodRemoveVariableAsync T (String, Func Response, T , String)

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
Public methodSearchAssociationsAsync(SearchCombinationOptions, IEnumerable String , SearchPage, String)
Public methodSearchAssociationsAsync T (SearchCombinationOptions, IEnumerable String , SearchPage, Func Response, T , String)
Public methodSearchSuggest

Returns search suggestions.

Public methodSearchSuggestAsync(SearchCombinationOptions, IEnumerable String , String)

Returns search suggestions.

Public methodSearchSuggestAsync T (SearchCombinationOptions, IEnumerable String , Func Response, T , String)

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, IEnumerable String , String, String)

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 T (String, String, String, IEnumerable String , String, Func Response, T , String)

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
Public methodSetFetchLimitAsync
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(IEnumerable Byte , String)

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 T (IEnumerable Byte , Func Response, T , String)

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 methodUndo

Undoes the previous operation.

Public methodUndoAsync(String)

Undoes the previous operation.

Public methodUndoAsync T (Func Response, T , String)

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.

Back to 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
Create dimension
(Defined by AppExtensions.)
Public Extension MethodCreateDimensionAsync
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
Create measure
(Defined by AppExtensions.)
Public Extension MethodCreateMeasureAsync
Create measure
(Defined by AppExtensions.)
Public Extension MethodCreateSheet
Create sheet
(Defined by AppExtensions.)
Public Extension MethodCreateSheetAsync
Create sheet
(Defined by AppExtensions.)
Public Extension MethodCreateSlideItem
(Defined by ClientExtension.)
Public Extension MethodCreateSnapshot
Create snapshot
(Defined by AppExtensions.)
Public Extension MethodCreateSnapshotAsync
Create snapshot
(Defined by AppExtensions.)
Public Extension MethodCreateStory Overloaded.
(Defined by ClientExtension.)
Public Extension MethodCreateStory(String, StoryProperties)Overloaded.
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 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
(Defined by SelectionExtensions.)
Public Extension MethodGetExtendedCurrentSelectionAsync
(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.)
Back to Top
Properties

  NameDescription
Public propertyHandle
The handle of the generic object.
(Inherited from QixClassBase.)
Public propertyId
(Inherited from QixClassBase.)
Public propertySession
The session this object resides in.
(Inherited from QixClassBase.)
Public propertyType
The type of the generic object.
(Inherited from QixClassBase.)
Back to Top
Events

  NameDescription
Public eventChanged
(Inherited from QixClassBase.)
Public eventClosed
(Inherited from QixClassBase.)
Public eventCommunicationError
This event is triggered when an communication error occurs.
Public eventMethodInvocationError
This event is triggered when an method invocation error occurs.
Back to Top
See Also