Table of Contents

Class Sxc

The typical sxc-instance object for a specific DNN module or content-block

Package: Api.Js.SxcJs

Properties

cbid

content-block ID, which is either the module ID, or the content-block definition entity ID this is an advanced concept you usually don't care about, otherwise you should research it

Declaration
cbid: number
Property Value
Type Description
number

cms

CMS operations on this sxc-instance, such as opening the edit dialog etc.

Declaration
cms: SxcCms
Property Value
Type Description
SxcCms

id

the sxc-instance ID, which is usually the DNN Module Id

Declaration
id: number
Property Value
Type Description
number

webApi

Web API calls for this instance. This is the pure call APIs system. To get data or queries, best use the data or query services.

Declaration
webApi: SxcWebApi
Property Value
Type Description
SxcWebApi

Methods

data(string)

Get a data service for a specific content-type.

Declaration
function data<T>(contentType: string)
Parameters
Type Name Description
string contentType
Returns
Type Description
SxcData<T>

isEditMode()

Test if the current code is in edit-mode and additional javascripts have been loaded to make it work

Declaration
function isEditMode()
Returns
Type Description
boolean

true if we are in edit-mode

query(string)

The typical sxc-instance object for a specific DNN module or content-block

Declaration
function query(query: string)
Parameters
Type Name Description
string query
Returns
Type Description
SxcQuery