Click or drag to resize
IGenericBookmark Interface
This class describes all the methods that apply at bookmark level.

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

The IGenericBookmark type exposes the following members.

Methods
  NameDescription
Public methodApply

Applies a bookmark.

Public methodApplyAsync(AsyncHandle)

Applies a bookmark.

Public methodApplyAsyncT(FuncResponse, T, AsyncHandle)

Applies a bookmark.

Public methodApplyPatches

Applies a patch to the properties of an object. Allows an update to some of the properties.

It is possible to apply a patch to the properties of a generic object, that is not persistent. Such a patch is called a soft patch. In that case, the result of the operation on the properties (add, remove or delete) is not shown when doing GetProperties and only a GetLayout call shows the result of the operation. Properties that are not persistent are called soft properties. Once the session is over, soft properties are cleared.

Applying a patch takes less time than resetting all the properties. 
Public methodApplyPatchesAsync

Applies a patch to the properties of an object. Allows an update to some of the properties.

It is possible to apply a patch to the properties of a generic object, that is not persistent. Such a patch is called a soft patch. In that case, the result of the operation on the properties (add, remove or delete) is not shown when doing GetProperties and only a GetLayout call shows the result of the operation. Properties that are not persistent are called soft properties. Once the session is over, soft properties are cleared.

Applying a patch takes less time than resetting all the properties. 
Public methodGetInfo

Returns:

* the type of the object

* the identifier of the object

Public methodGetInfoAsync(AsyncHandle)

Returns:

* the type of the object

* the identifier of the object

Public methodGetInfoAsyncT(FuncResponse, T, AsyncHandle)

Returns:

* the type of the object

* the identifier of the object

Public methodGetLayout

Evaluates an object and displays its properties including the dynamic properties. If the member delta is set to true in the request object, only the delta is evaluated. A GetLayout call on a generic object, returns up to one level down in the hierarchy.

Public methodGetLayoutAsync(AsyncHandle)

Evaluates an object and displays its properties including the dynamic properties. If the member delta is set to true in the request object, only the delta is evaluated. A GetLayout call on a generic object, returns up to one level down in the hierarchy.

Public methodGetLayoutAsyncT(FuncResponse, T, AsyncHandle)

Evaluates an object and displays its properties including the dynamic properties. If the member delta is set to true in the request object, only the delta is evaluated. A GetLayout call on a generic object, returns up to one level down in the hierarchy.

Public methodGetProperties

Shows the properties of an object.

If the member delta is set to true in the request object, only the delta is retrieved.
Public methodGetPropertiesAsync(AsyncHandle)

Shows the properties of an object.

If the member delta is set to true in the request object, only the delta is retrieved.
Public methodGetPropertiesAsyncT(FuncResponse, T, AsyncHandle)

Shows the properties of an object.

If the member delta is set to true in the request object, only the delta is retrieved.
Public methodPublish

Publishes a bookmark.

Public methodPublishAsync

Publishes a bookmark.

Public methodResumeLayout
Public methodSetProperties

Sets some properties for a bookmark.

Public methodSetPropertiesAsync

Sets some properties for a bookmark.

Public methodSuspendLayout
Public methodUnPublish

Unpublishes a bookmark.

Public methodUnPublishAsync

Unpublishes a bookmark.

Top
Properties
  NameDescription
Public propertyBookmark
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 propertyInfo
Public propertyMeta
Public propertyProperties
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.)
Top
See Also