Skip to main content Skip to complementary content

QixClassBase Class

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

Instances of this class represent objects known to the Qlik Sense Engine.

Inheritance

Syntax

public abstract class QixClassBase : IQixClassBase, IDisposable, IChangeNotifier

Constructors

Name Description
QixClassBase(Int32, String)

Create a C# representation of a qix object.

QixClassBase(Int32, String, IQlikConnection)

Create a C# representation of a qix object.

Properties

Name Description
ConsiderDirty

Forces send of GetProperties and GetLayout calls to engine for this object even when the layout and properties are up to date.

ConsideredDirty

Forces send of GetProperties and GetLayout calls to engine for this object even when the layout and properties are up to date. Resume normal behavior when disposed.

Handle

The handle of the Qlik Sense entity.

Id

The id of the Qlik Sense entity.

IsClosed

Flag indicating whether or not a closed event has been received for the object.

Session

The session this entity resides in.

ShouldDelayChange

Indicates if the entity will handle changes at a later time

Type

The type of the Qlik Sense entity.

Methods

Name Description
AsValue<T>(Response, String)

Convenience method to create instances from the response

AsValueStructure<T>(Response)

Convenience method to create instances from the response result

DidChangeLayout()

Callback after layout has changed.

Dispose()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

Dispose(Boolean)

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

OnChanged()

Invokes the Changed event if possible.

OnClose()

Invokes the Close Event

OnDirty()

Invokes the Changed Event with full dirty handling if possible

OnDisposing()

Invokes the Disposing Event

ReadJson(JsonReader, QlikConnection)

Method for updating an object according to a Qix json object.

TokenToQixObject(JToken, Type, String, JsonSerializer)

Deserialize a Newtonsoft.Json.Linq.JToken to an object of a class extending QixClassBase.

WillChangeLayout()

Callback before layout changes.

Events

Name Description
Changed

This event fires when a modification has occurred to the Qlik Sense entity's selection state, data or properties.

Closed

This event fires when the Qlik Sense entity has been removed or deleted.

Disposing

This event fires when the Qlik Sense entity is being disposed.

Did this page help you?

If you find any issues with this page or its content – a typo, a missing step, or a technical error – let us know how we can improve!