API Framework References

Functions

RegisterOnEvents

Description

Registers on application events.

Signature

HRESULT RegisterOnEvents ([in] long Cookie)

Parameters

[in] long Cookie

Details / Examples

Registers on application events.

  • Cookie The cookie.

EomQueryInterface

Description

Returns an interface pointer.

Signature

HRESULT EomQueryInterface ([in] BSTR IntfName, [out, retval] IDispatch **ppInterface)

Parameters

[in] BSTR IntfName
[out, retval] IDispatch ** ppInterface

Details / Examples

Returns an interface pointer.

  • IntfName The interface name.

ManageAddIns

Description

Opens the AddIn Manager dialog.

Signature

HRESULT ManageAddIns (void)

Parameters

` void `

Details / Examples

The AddIn Manager dialog let the user see all the defined and loaded addins, install new addins, temporarly disable the loaded addins

  • void

AddInDebugSettings

Description

Get The addin debug settings.

Signature

HRESULT AddInDebugSettings ([in] long Cookie, [out, retval] BSTR *ppDebugSettings)

Parameters

[in] long Cookie
[out, retval] BSTR * ppDebugSettings

AddNewAddin

Description

Add an Addin manually.

Signature

HRESULT AddNewAddin ([in] BSTR addinName, [in] BSTR addinPath, [in] BSTR addinDesc, [in] BOOL addinIsEnabled)

Parameters

[in] BSTR addinName
[in] BSTR addinPath
[in] BSTR addinDesc
[in] BOOL addinIsEnabled

Details / Examples

This call is used by the wpf toolbar for the new <EOM:Addin> resource

  • addinName

  • addinPath

  • addinDesc

  • addinIsEnabled

CallAddinCommand

Description

Call the Addin Command manually.

Signature

HRESULT CallAddinCommand ([in] BSTR addinName, [in] long addinCommandId)

Parameters

[in] BSTR addinName
[in] long addinCommandId

Details / Examples

This call is used by the wpf toolbar for the new <EOM:AddinButtons>

  • addinName

  • addinCommandId

RunMacroFile

Description

Run macro file.

Signature

HRESULT RunMacroFile ([in] BSTR filepath)

Parameters

[in] BSTR filepath

Details / Examples

This call is used by the wpf toolbar for the new <EOM:MacroButton>

  • filepath

Open

Description

Open a document, passing a full file uri.

Signature

HRESULT Open ([in] BSTR sUriName, [in] VARIANT_BOOL ReadOnly)

Parameters

[in] BSTR sUriName
[in] VARIANT_BOOL ReadOnly

GetUserPrefsConfigString

Description

Get a string value from XsmilePrefs.cfg.

Signature

HRESULT GetUserPrefsConfigString ([in] BSTR sNodePath, [out, retval] BSTR *pValue)

Parameters

[in] BSTR sNodePath
[out, retval] BSTR * pValue

RegisterKbdCommand

Description

Register a keyboard command.

Signature

HRESULT RegisterKbdCommand ([in] BSTR sKbdContext, [in] int keyCode, [in] VARIANT_BOOL bCtrlKey, [in] VARIANT_BOOL bShiftKey, [in] VARIANT_BOOL bAltKey, [in] int nCookie, [in] int nCommand)

Parameters

[in] BSTR sKbdContext
[in] int keyCode
[in] VARIANT_BOOL bCtrlKey
[in] VARIANT_BOOL bShiftKey
[in] VARIANT_BOOL bAltKey
[in] int nCookie
[in] int nCommand

SetKbdCommand

Description

Register a keyboard command.

Signature

HRESULT SetKbdCommand ([in] BSTR sKbdContext, [in] BSTR FunctionName, [in] BSTR FunctionData, [in] int keyCode, [in] int fFlags)

Parameters

[in] BSTR sKbdContext
[in] BSTR FunctionName
[in] BSTR FunctionData
[in] int keyCode
[in] int fFlags

ExecuteKbdCommand

Description

Execute a keyboard command.

Signature

HRESULT ExecuteKbdCommand ([in] BSTR FunctionName, [in] BSTR FunctionData)

Parameters

[in] BSTR FunctionName
[in] BSTR FunctionData

ExecServelet

Description

Launch a servlet.

Signature

HRESULT ExecServelet ([in] BSTR strServlet)

Parameters

[in] BSTR strServlet

ExecApplication

Description

Launch an application.

Signature

HRESULT ExecApplication ([in] BSTR strCmdLine)

Parameters

[in] BSTR strCmdLine

ShellExecute

Description

Performs an operation on a specified file.

Signature

HRESULT ShellExecute ([in] BSTR strOperation, [in] BSTR strFile, [in] BSTR strParameters, [in] BSTR strDirectory, [in] int nShowCmd, [out, retval] VARIANT_BOOL *pSuccess)

Parameters

[in] BSTR strOperation
[in] BSTR strFile
[in] BSTR strParameters
[in] BSTR strDirectory
[in] int nShowCmd
[out, retval] VARIANT_BOOL * pSuccess

Details / Examples

Performs an operation on a specified file.

  • strOperation: edit Launches an editor and opens the document for editing. If lpFile is not a document file, the function will fail. explore Explores a folder specified by lpFile. find Initiates a search beginning in the directory specified by lpDirectory. open Opens the item specified by the lpFile parameter. The item can be a file or folder. print Prints the file specified by lpFile. If lpFile is not a document file, the function fails. NULL The default verb is used, if available. If not, the "open" verb is used. If neither verb is available, the system uses the first verb listed in the registry.

  • strFile: A pointer to a null-terminated string that specifies the file or object on which to execute the specified verb

  • strParameters: Parameters to be passed to the application

  • strDirectory: The default (working) directory for the action. If this value is NULL, the current working directory is used

  • nShowCmd: The flags that specify how an application is to be displayed when it is opened. 0: hide 3: maximize 6: minimize 5: Activates the window and displays it in its current size and position.

CreateXsmileDocFromTemplate

Description

Create a new dom document from a template.

Signature

HRESULT CreateXsmileDocFromTemplate ([in] BSTR strTemplate, [out, retval] VARIANT_BOOL *pSuccess)

Parameters

[in] BSTR strTemplate
[out, retval] VARIANT_BOOL * pSuccess

CreateXsmileDocFromShapeTemplate

Description

Create a new dom document from a template.

Signature

HRESULT CreateXsmileDocFromShapeTemplate ([in] BSTR strTemplate, [out, retval] VARIANT_BOOL *pSuccess)

Parameters

[in] BSTR strTemplate
[out, retval] VARIANT_BOOL * pSuccess

CreateXsmileDocFromBuffer

Description

Create a new dom document from external memory buffer.

Signature

HRESULT CreateXsmileDocFromBuffer ([in] BSTR strProposedName, [in] BSTR strTemplate, [in] BSTR FileBuffer, [in] BSTR MetadataBuffer, [in] VARIANT_BOOL bQuick, [out, retval] BSTR *pNewDocName)

Parameters

[in] BSTR strProposedName
[in] BSTR strTemplate
[in] BSTR FileBuffer
[in] BSTR MetadataBuffer
[in] VARIANT_BOOL bQuick
[out, retval] BSTR * pNewDocName

CreateMethodeDocFromExternalUri

Description

Create a new document from external uri.

Signature

HRESULT CreateMethodeDocFromExternalUri ([in] BSTR sUri, [in] BSTR sCommand, [out, retval] BSTR *pNewDocName)

Parameters

[in] BSTR sUri
[in] BSTR sCommand
[out, retval] BSTR * pNewDocName

CreateXsmileChainedDoc

Description

Create a new document chained to given.

Signature

HRESULT CreateXsmileChainedDoc ([in] BSTR sMainPathName, [in] BSTR sChainTag, [in] BSTR sBodyContentItem, [in] BSTR sBodyFragment, [in] BSTR sOptions, [out, retval] BSTR *pNewDocName)

Parameters

[in] BSTR sMainPathName
[in] BSTR sChainTag
[in] BSTR sBodyContentItem
[in] BSTR sBodyFragment
[in] BSTR sOptions
[out, retval] BSTR * pNewDocName

StartPlanExport

Description

Signature

HRESULT StartPlanExport (BSTR sOutputManager)

Parameters

` BSTR sOutputManager`

EndPlanExport

Description

Signature

HRESULT EndPlanExport ()

Parameters

SetParam

Description

Set string parameter.

Signature

HRESULT SetParam ([in] BSTR sParam, [in] BSTR sValue)

Parameters

[in] BSTR sParam
[in] BSTR sValue

GetParam

Description

Get string parameter.

Signature

HRESULT GetParam ([in] BSTR sParam, [out, retval] BSTR *pValue)

Parameters

[in] BSTR sParam
[out, retval] BSTR * pValue

RemoveParam

Description

Remove string parameter.

Signature

HRESULT RemoveParam ([in] BSTR sParam)

Parameters

[in] BSTR sParam

GetEventParam

Description

Get last fired event data.

Signature

HRESULT GetEventParam ([out, retval] BSTR *pValue)

Parameters

[out, retval] BSTR * pValue

ResolveSysVar

Description

Resolves the system variable.

Signature

HRESULT ResolveSysVar ([in] BSTR Label, [in] BSTR Format, [out, retval] BSTR *pValue)

Parameters

[in] BSTR Label
[in] BSTR Format
[out, retval] BSTR * pValue

MsgBox

Description

Shows a message box.

Signature

HRESULT MsgBox ([in] BSTR Text, [in] BSTR Caption, [in] int uType, [out, retval] int *pValue)

Parameters

[in] BSTR Text
[in] BSTR Caption
[in] int uType
[out, retval] int * pValue

Details / Examples

DEPRECATED (in some cases the MessageBox has no parent): please use IWindow.MsgBox (same params)

  • Text: the text of the message

MsgBoxPopup

Description

Message Box Popup.

Signature

HRESULT MsgBoxPopup ([in] BSTR sMessage)

Parameters

[in] BSTR sMessage

InstallWorkflowHandler

Description

Take control of workflow application and error handling messages.

Signature

HRESULT InstallWorkflowHandler ([in] VARIANT_BOOL bValue)

Parameters

[in] VARIANT_BOOL bValue

InstallEventHandler

Description

Signature

HRESULT InstallEventHandler ([in] BSTR sEventName)

Parameters

[in] BSTR sEventName

handleKey

Description

Handle context keyboard shortcuts.

Signature

HRESULT handleKey ([in] int iChar, [out, retval] VARIANT_BOOL *pRet)

Parameters

[in] int iChar
[out, retval] VARIANT_BOOL * pRet

CreateStoryPreview

Description

Signature

HRESULT CreateStoryPreview ([in] BSTR StoryBuffer, [in] BSTR StoryPgx, [in] BSTR sInputParams, [out, retval] BSTR *pOutputParams)

Parameters

[in] BSTR StoryBuffer
[in] BSTR StoryPgx
[in] BSTR sInputParams
[out, retval] BSTR * pOutputParams

GetDbContextList

Description

Signature

HRESULT GetDbContextList ([out, retval] BSTR *pData)

Parameters

[out, retval] BSTR * pData

ReadLocalFile

Description

Read a file from local file system.

Signature

HRESULT ReadLocalFile ([in] BSTR sLocalPath, [in] int fFlags, [out, retval] BSTR *pFileBuffer)

Parameters

[in] BSTR sLocalPath
[in] int fFlags
[out, retval] BSTR * pFileBuffer

StoreLocalFile

Description

Store a file to local file system.

Signature

HRESULT StoreLocalFile ([in] BSTR sLocalPath, [in] int fFlags, [in] BSTR sfileBuffer, [out, retval] VARIANT_BOOL *pRet)

Parameters

[in] BSTR sLocalPath
[in] int fFlags
[in] BSTR sfileBuffer
[out, retval] VARIANT_BOOL * pRet

CopyLocalDir

Description

Copy a local directory to a local destination.

Signature

HRESULT CopyLocalDir ([in] BSTR sLocalPath, [in] BSTR sDestPath, [out, retval] VARIANT_BOOL *pRet)

Parameters

[in] BSTR sLocalPath
[in] BSTR sDestPath
[out, retval] VARIANT_BOOL * pRet

RenameLocalFile

Description

Rename a local file.

Signature

HRESULT RenameLocalFile ([in] BSTR sLocalPath, [in] BSTR sDestPath, [out, retval] BSTR *pNewName)

Parameters

[in] BSTR sLocalPath
[in] BSTR sDestPath
[out, retval] BSTR * pNewName

DeleteLocalFile

Description

Delete a local file.

Signature

HRESULT DeleteLocalFile ([in] BSTR sLocalPath, [out, retval] VARIANT_BOOL *pRet)

Parameters

[in] BSTR sLocalPath
[out, retval] VARIANT_BOOL * pRet

DeleteLocalUserFolder

Description

Signature

HRESULT DeleteLocalUserFolder ([in] BSTR sLocalPath, [out, retval] VARIANT_BOOL *pRet)

Parameters

[in] BSTR sLocalPath
[out, retval] VARIANT_BOOL * pRet

HandleLocalFileUploaded

Description

Signature

HRESULT HandleLocalFileUploaded ([in] BSTR sFileName, [out, retval] VARIANT_BOOL *pSuccess)

Parameters

[in] BSTR sFileName
[out, retval] VARIANT_BOOL * pSuccess

GetCreationDom

Description

Returns the dom of the document that is being created.

Signature

HRESULT GetCreationDom ([out, retval] BSTR *pValue)

Parameters

[out, retval] BSTR * pValue

SetCreationDom

Description

Replace the dom of the document that is being created.

Signature

HRESULT SetCreationDom ([in] BSTR sValue)

Parameters

[in] BSTR sValue

GetCreationData

Description

Returns the data of the document that is being created in Json format (channel, inherit)

Signature

HRESULT GetCreationData ([out, retval] BSTR *pValue)

Parameters

[out, retval] BSTR * pValue

GetToolbarData

Description

Signature

HRESULT GetToolbarData ([in] BSTR dataType, [out, retval] BSTR *pJsonData)

Parameters

[in] BSTR dataType
[out, retval] BSTR * pJsonData

GetImagePresetCrops

Description

Signature

HRESULT GetImagePresetCrops ([out, retval] BSTR *pCropData)

Parameters

[out, retval] BSTR * pCropData

GetAddinPath

Description

Signature

HRESULT GetAddinPath ([in] int Cookie, [out, retval] BSTR *pRetPath)

Parameters

[in] int Cookie
[out, retval] BSTR * pRetPath

GetSiteConfigString

Description

Returns the value from siteConfig.

Signature

HRESULT GetSiteConfigString ([in] BSTR sNodePath, [out, retval] BSTR *pValue)

Parameters

[in] BSTR sNodePath
[out, retval] BSTR * pValue

GetData

Description

Asks Methode some data using a Json input string.

Signature

HRESULT GetData ([in] BSTR pJsonInput, [out, retval] BSTR *pJsonData)

Parameters

[in] BSTR pJsonInput
[out, retval] BSTR * pJsonData

Details / Examples

This is a generic interface that can be used in future to cover different needs without any Automation modification The Json request is structured like this: {"dataRequest" : "<Value>"} (Other properties could be added according with the request type) The Json response is structured like this: {"dataResponse" : "<Value>"} (Other properties could be added according with the request type) Supported request: "GetMethodeHtmlPath" ⇒ Returns the "standard" methode HTML path "GetAddinPath" ⇒ Return the addin root path as registered inside the registry (the path where the js is located) "IsDebug" ⇒ Return true if Methode is compiled in Debug mode

LoadWpfExternalResources

Description

Create/Select a wpf based panel.

Signature

HRESULT LoadWpfExternalResources ([in] BSTR Url, [in] BSTR Parameters, [out, retval] BSTR *pValue)

Parameters

[in] BSTR Url
[in] BSTR Parameters
[out, retval] BSTR * pValue

GetRecentFileList

Description

Signature

HRESULT GetRecentFileList ([out, retval] BSTR *pJsonString)

Parameters

[out, retval] BSTR * pJsonString

OpenRecentFileList

Description

Signature

HRESULT OpenRecentFileList ([in] int fileId)

Parameters

[in] int fileId

GetInstallLanguageCultureName

Description

Signature

HRESULT GetInstallLanguageCultureName ([out, retval] BSTR *pString)

Parameters

[out, retval] BSTR * pString

SetPanelParentFrame

Description

Signature

HRESULT SetPanelParentFrame ([in] int hwnd)

Parameters

[in] int hwnd

GetConfigFilePath

Description

Get config file path.

Signature

HRESULT GetConfigFilePath ([in] BSTR sFileName, [out, retval] BSTR *pFilePath)

Parameters

[in] BSTR sFileName
[out, retval] BSTR * pFilePath

CreateDocumentPdf

Description

Signature

HRESULT CreateDocumentPdf ([in] BSTR sInputParams, [out, retval] BSTR *pOutputData)

Parameters

[in] BSTR sInputParams
[out, retval] BSTR * pOutputData

DownloadOffline

Description

Signature

HRESULT DownloadOffline ([in] BSTR sInputParams, [out, retval] BSTR *pOutputData)

Parameters

[in] BSTR sInputParams
[out, retval] BSTR * pOutputData

_GetDocument

Description

Signature

HRESULT _GetDocument ([in] BSTR json, [out, retval] IXDocument **prop)

Parameters

[in] BSTR json
[out, retval] IXDocument ** prop

Properties

ExcelHelper

Description

Signature

IExcelHelper ExcelHelper

Type

GET

AppServices

Description

Signature

IAppServices AppServices

Type

GET

MethodeVersion

Description

Returns the methode version.

Signature

BSTR MethodeVersion

Type

GET

Users

Description

Returns the collection of all users.

Signature

IUsers Users

Type

GET

Windows

Description

Returns the collection of all windows.

Signature

IWindows Windows

Type

GET

Documents

Description

Returns the collection that contains all the open documents.

Signature

IDocuments Documents

Type

GET

ActiveDocument

Description

Returns the active document interface.

Signature

IXDocument ActiveDocument

Type

GET

ActiveWindow

Description

Returns the active window interface.

Signature

IWindow ActiveWindow

Type

GET

ActiveUser

Description

Returns the active user interface.

Signature

IUser ActiveUser

Type

GET

ActiveChannel

Description

Current channel.

Signature

BSTR ActiveChannel

Type

GET SET

ActiveIssueDate

Description

Current issue date.

Signature

BSTR ActiveIssueDate

Type

GET SET

ActiveWorkFolder

Description

Current workfolder.

Signature

BSTR ActiveWorkFolder

Type

GET SET

AddinErrorCode

Description

Sets a plugin error code (0 means no errors)

Signature

int AddinErrorCode

Type

SET

AddinErrorMessage

Description

Sets a plugin error message (can be combined with the error code)

Signature

BSTR AddinErrorMessage

Type

SET

MethodeHtmlPath

Description

Signature

BSTR MethodeHtmlPath

Type

GET

MethodeCmdLine

Description

The Methode’s command line.

Signature

BSTR MethodeCmdLine

Type

GET

Xsmart::IWindow API Documentation

Functions

RegisterOnEvents

Description

Register on window events.

Signature

HRESULT RegisterOnEvents ([in] long Cookie)

Parameters

[in] long Cookie

AddToolbar

Description

Signature

HRESULT AddToolbar ([in] emBarPosition Position, [in] int X, [in] int Y, [in] BSTR Caption, [in] int resId, [out, retval] int *pToolbarId)

Parameters

[in] emBarPosition Position
[in] int X
[in] int Y
[in] BSTR Caption
[in] int resId
[out, retval] int * pToolbarId

Details / Examples

Add a new toolbar to the application.

  • Position The position of the toolbar

  • X, Y Screen coordinates of the top left corner of the window, provide -1,-1 for the default value

  • Caption A string that will be used as the toolbar caption when it’s in an undocked state

  • resId Internal resource id Returns an integer identifying the newly created toolbar that addins must provide when adding icons to the new toolbar

CloseToolbar

Description

Close the toolbar.

Signature

HRESULT CloseToolbar ([in] int ToolbarId)

Parameters

[in] int ToolbarId

ShowToolbar

Description

Show or hide the toolbar.

Signature

HRESULT ShowToolbar ([in] int ToolbarId, [in] VARIANT_BOOL bShow)

Parameters

[in] int ToolbarId
[in] VARIANT_BOOL bShow

IsToolbarVisible

Description

Check if the toolbar is visible or not.

Signature

HRESULT IsToolbarVisible ([in] int ToolbarId, [out, retval] VARIANT_BOOL *bVisible)

Parameters

[in] int ToolbarId
[out, retval] VARIANT_BOOL * bVisible

AddButtonBmp

Description

Signature

HRESULT AddButtonBmp ([in] emCtrlContainer CtrlContainer, [in] emCtrlPosition CtrlPosition, [in] long CtrlId, [in] BSTR Bitmap, [in] BSTR CtrlDescription, [in] long Cookie)

Parameters

[in] emCtrlContainer CtrlContainer
[in] emCtrlPosition CtrlPosition
[in] long CtrlId
[in] BSTR Bitmap
[in] BSTR CtrlDescription
[in] long Cookie

AddControl

Description

Signature

HRESULT AddControl ([in] emCtrlType CtrlType, [in] emCtrlContainer CtrlContainer, [in] emCtrlPosition CtrlPosition, [in] long CtrlId, [in] int iImage, [in] VARIANT_BOOL bUserBitmap, [in] BSTR CtrlName, [in] BSTR CtrlDescription, [in] long Cookie)

Parameters

[in] emCtrlType CtrlType
[in] emCtrlContainer CtrlContainer
[in] emCtrlPosition CtrlPosition
[in] long CtrlId
[in] int iImage
[in] VARIANT_BOOL bUserBitmap
[in] BSTR CtrlName
[in] BSTR CtrlDescription
[in] long Cookie

Details / Examples

Add/Insert/Remove a new user interface control that when selected will call an addin command.

  • CtrlPosition A standard position inside CtrlContainer. When CtrlContainer is emCtrlContainerCustomToolbar provide the id of the toolbar as returned by AddToolbar

  • CtrlId A number that identifies the command. This number will be passed back to the "OnCommand" addin function.

  • CtrlName The name of the control. For menu items this will be the item text, for "char" toolbar buttons (emCtrlTypeCharButton) it will be used to generate the button bitmap if it’s in the format <char>|<font>, for example "A|Arial"

  • CtrlDescription Provides a description of the command, in the format <description>

InsertControl

Description

Signature

HRESULT InsertControl ([in] emCtrlType CtrlType, [in] emCtrlContainer CtrlContainer, [in] emCtrlPosition CtrlPosition, [in] long CtrlId, [in] int iCtrlIndex, [in] int iImage, [in] VARIANT_BOOL bUserBitmap, [in] BSTR CtrlName, [in] BSTR CtrlDescription, [in] long Cookie)

Parameters

[in] emCtrlType CtrlType
[in] emCtrlContainer CtrlContainer
[in] emCtrlPosition CtrlPosition
[in] long CtrlId
[in] int iCtrlIndex
[in] int iImage
[in] VARIANT_BOOL bUserBitmap
[in] BSTR CtrlName
[in] BSTR CtrlDescription
[in] long Cookie

RemoveControl

Description

Signature

HRESULT RemoveControl ([in] emCtrlType CtrlType, [in] emCtrlPosition CtrlPosition, [in] long CtrlId, [in] long Cookie)

Parameters

[in] emCtrlType CtrlType
[in] emCtrlPosition CtrlPosition
[in] long CtrlId
[in] long Cookie

AddButtonWithImgFile

Description

Add Button with image file.

Signature

HRESULT AddButtonWithImgFile ([in] emCtrlContainer CtrlContainer, [in] emCtrlPosition CtrlPosition, [in] long CtrlId, [in] BSTR ImgFilePath, [in] BSTR CtrlDescription, [in] long Cookie)

Parameters

[in] emCtrlContainer CtrlContainer
[in] emCtrlPosition CtrlPosition
[in] long CtrlId
[in] BSTR ImgFilePath
[in] BSTR CtrlDescription
[in] long Cookie

GetPanel

Description

The Panel by name associated to this window.

Signature

HRESULT GetPanel ([in] BSTR PanelName, [out, retval] IDockablePane **pDockablePane)

Parameters

[in] BSTR PanelName
[out, retval] IDockablePane ** pDockablePane

ToggleTools

Description

Show/Hide the tool windows.

Signature

HRESULT ToggleTools ()

Parameters

SelectWorkspace

Description

Signature

HRESULT SelectWorkspace ([in] BSTR WorkspaceName)

Parameters

[in] BSTR WorkspaceName

Details / Examples

Loads a workspace

  • Name of the workspace to be loaded

ReadFile

Description

Signature

HRESULT ReadFile ([in] BSTR FileUri, [in] int fFlags, [out, retval] BSTR *pFileBuffer)

Parameters

[in] BSTR FileUri
[in] int fFlags
[out, retval] BSTR * pFileBuffer

Details / Examples

Read an xml file from the database of the active document or the database sepcified in the input uri (result in UTF16)

  • Full uri of the file to be read.

  • fFlags A combination of the following values: 1 - silent mode. No error messages will be displayed. 4 - Store the file content to the local cache. Following calls will take the content from that.

  • pFileBuffer String that will contain the contents of the file

ReadFileEx

Description

Signature

HRESULT ReadFileEx ([in] BSTR sFileUri, [in] BSTR sParams, [out, retval] BSTR *pFileBuffer)

Parameters

[in] BSTR sFileUri
[in] BSTR sParams
[out, retval] BSTR * pFileBuffer

StoreFile

Description

Signature

HRESULT StoreFile ([in] BSTR FileNameUri, [in] BSTR FileBuffer, [in] int fFlags, [out, retval] BSTR *pLoid)

Parameters

[in] BSTR FileNameUri
[in] BSTR FileBuffer
[in] int fFlags
[out, retval] BSTR * pLoid

Details / Examples

Writes an xml file to the database of the active document (expects input in UTF16)

  • Full uri of the file to be written.

  • String that contains the contents of the file

StoreFileEx

Description

Signature

HRESULT StoreFileEx ([in] BSTR FileData, [in] BSTR FileBuffer, [in] BSTR SysAttributes, [in] BSTR Attributes, [out, retval] BSTR *pResultData)

Parameters

[in] BSTR FileData
[in] BSTR FileBuffer
[in] BSTR SysAttributes
[in] BSTR Attributes
[out, retval] BSTR * pResultData

ReadBinaryFile

Description

Signature

HRESULT ReadBinaryFile ([in] BSTR FileNameUri, [in] int fFlags, [out, retval] BSTR *pFileBuffer)

Parameters

[in] BSTR FileNameUri
[in] int fFlags
[out, retval] BSTR * pFileBuffer

Details / Examples

Read binary file

  • Full uri of the file to read.

  • fFlags A combination of the following values: 1 - silent mode. No error messages will be displayed. 8 - base64 encoded buffer.

StoreBinaryFile

Description

Signature

HRESULT StoreBinaryFile ([in] BSTR FileNameUri, [in] BSTR FileBuffer, [in] int fFlags, [out, retval] BSTR *pLoid)

Parameters

[in] BSTR FileNameUri
[in] BSTR FileBuffer
[in] int fFlags
[out, retval] BSTR * pLoid

Details / Examples

Writes a binary file the the database

  • Full uri of the file to be written.

  • String that contains the contents of the file

  • fFlags A combination of the following values: 1 - silent mode. No error messages will be displayed. 8 - base64 encoded buffer.

DeleteBinaryFile

Description

Delete file.

Signature

HRESULT DeleteBinaryFile ([in] BSTR FileNameUri, [out, retval] VARIANT_BOOL *pResult)

Parameters

[in] BSTR FileNameUri
[out, retval] VARIANT_BOOL * pResult

GetServletSessionKey

Description

Returns the servlet session key ("skey")

Signature

HRESULT GetServletSessionKey ([in] BSTR sUrl, [out, retval] BSTR *pValue)

Parameters

[in] BSTR sUrl
[out, retval] BSTR * pValue

GetSiteConfigString

Description

Returns the value from siteConfig.

Signature

HRESULT GetSiteConfigString ([in] BSTR sNodePath, [out, retval] BSTR *pValue)

Parameters

[in] BSTR sNodePath
[out, retval] BSTR * pValue

Close

Description

Close the window.

Signature

HRESULT Close ([out, retval] VARIANT_BOOL *pValue)

Parameters

[out, retval] VARIANT_BOOL * pValue

ExecuteKbdCommand

Description

Execute a keyboard command.

Signature

HRESULT ExecuteKbdCommand ([in] BSTR FunctionName, [in] BSTR FunctionData)

Parameters

[in] BSTR FunctionName
[in] BSTR FunctionData

OpenWebPanel

Description

Create/Select a html browser based panel.

Signature

HRESULT OpenWebPanel ([in] BSTR Url)

Parameters

[in] BSTR Url

OpenWpfPanel

Description

Create/Select a wpf based panel.

Signature

HRESULT OpenWpfPanel ([in] BSTR Url)

Parameters

[in] BSTR Url

CloseWebPanel

Description

Close a html browser based panel.

Signature

HRESULT CloseWebPanel ([in] BSTR Url)

Parameters

[in] BSTR Url

OpenPanelEx

Description

Create/Select a html shared swing panel.

Signature

HRESULT OpenPanelEx ([in] BSTR params)

Parameters

[in] BSTR params

OpenScriptEditorPanel

Description

Create/Select a script editor panel.

Signature

HRESULT OpenScriptEditorPanel (void)

Parameters

` void `

OpenWebDialog

Description

Create a html browser based dialog.

Signature

HRESULT OpenWebDialog ([in] BSTR Url, [in] int cx, [in] int cy, [out, retval] VARIANT_BOOL *pResult)

Parameters

[in] BSTR Url
[in] int cx
[in] int cy
[out, retval] VARIANT_BOOL * pResult

OpenChromeWebDialog

Description

Create a html browser based dialog using explicitly Chrome browser engine * EXPERIMENTAL *.

Signature

HRESULT OpenChromeWebDialog ([in] BSTR Url, [in] int cx, [in] int cy, [out, retval] VARIANT_BOOL *pResult)

Parameters

[in] BSTR Url
[in] int cx
[in] int cy
[out, retval] VARIANT_BOOL * pResult

ResolveSysVar

Description

Resolves the system variable.

Signature

HRESULT ResolveSysVar ([in] BSTR Label, [in] BSTR Format, [out, retval] BSTR *pValue)

Parameters

[in] BSTR Label
[in] BSTR Format
[out, retval] BSTR * pValue

CanRunAddinCmd

Description

Controls if an addin can run a command.

Signature

HRESULT CanRunAddinCmd ([in] BSTR AddinName, [in] int nAddinCmd, [out, retval] VARIANT_BOOL *pResult)

Parameters

[in] BSTR AddinName
[in] int nAddinCmd
[out, retval] VARIANT_BOOL * pResult

HasPrivilege

Description

Controls if the active user can run a command.

Signature

HRESULT HasPrivilege ([in] int idSlot, [in] int nCommand, [out, retval] VARIANT_BOOL *pResult)

Parameters

[in] int idSlot
[in] int nCommand
[out, retval] VARIANT_BOOL * pResult

FireEvent

Description

Fire an event to be received in WebPanel’s OnEvent handler.

Signature

HRESULT FireEvent ([in] BSTR sEventName)

Parameters

[in] BSTR sEventName

SelectUsers

Description

Shows the user list.

Signature

HRESULT SelectUsers ([in] BSTR sSelectUsers, [out, retval] BSTR *pUsers)

Parameters

[in] BSTR sSelectUsers
[out, retval] BSTR * pUsers

GetUser

Description

Get a specific user by name.

Signature

HRESULT GetUser ([in] BSTR sUserName, [out, retval] IUser **pUser)

Parameters

[in] BSTR sUserName
[out, retval] IUser ** pUser

GetDirNameFromUser

Description

Get dir name from user.

Signature

HRESULT GetDirNameFromUser ([in] BSTR sPaneID, [in] BSTR sRootName, [in] BSTR sCurrentDir, [out, retval] BSTR *pDirPath)

Parameters

[in] BSTR sPaneID
[in] BSTR sRootName
[in] BSTR sCurrentDir
[out, retval] BSTR * pDirPath

GetSaveFileNameFromUser

Description

Get a file name to save from user.

Signature

HRESULT GetSaveFileNameFromUser ([in] BSTR sPaneID, [in] BSTR sFileNameCurrent, [in] BSTR sInitialDir, [in] BSTR sFilter, [in] BSTR sExt, [out, retval] BSTR *pFilePath)

Parameters

[in] BSTR sPaneID
[in] BSTR sFileNameCurrent
[in] BSTR sInitialDir
[in] BSTR sFilter
[in] BSTR sExt
[out, retval] BSTR * pFilePath

GetOpenFileNameFromUser

Description

Get a file name to open from user.

Signature

HRESULT GetOpenFileNameFromUser ([in] BSTR sPaneID, [in] BSTR sInitialDir, [in] BSTR sFilter, [out, retval] BSTR *pFilePath)

Parameters

[in] BSTR sPaneID
[in] BSTR sInitialDir
[in] BSTR sFilter
[out, retval] BSTR * pFilePath

GetWorkflows

Description

Get list of available workflow names for the specified type (or all if type is empty)

Signature

HRESULT GetWorkflows ([in] BSTR sObjectType, [out, retval] BSTR *pNames)

Parameters

[in] BSTR sObjectType
[out, retval] BSTR * pNames

GetWorkflowSteps

Description

Get list of workflow steps for given workflow.

Signature

HRESULT GetWorkflowSteps ([in] BSTR sWorkFlow, [out, retval] BSTR *pNames)

Parameters

[in] BSTR sWorkFlow
[out, retval] BSTR * pNames

GetWorkflowColor

Description

Get workflow color from workflow path.

Signature

HRESULT GetWorkflowColor ([in] BSTR sWorkFlowPath, [out, retval] BSTR *pColor)

Parameters

[in] BSTR sWorkFlowPath
[out, retval] BSTR * pColor

SetFocus

Description

Set Focus to this window.

Signature

HRESULT SetFocus (void)

Parameters

` void `

ShowPopupMenu

Description

Show popup menu for items in loids (comma separated).

Signature

HRESULT ShowPopupMenu ([in] BSTR loids)

Parameters

[in] BSTR loids

Inspect

Description

Show an url into the inspector pane.

Signature

HRESULT Inspect ([in] BSTR url)

Parameters

[in] BSTR url

DocumentFromUri

Description

Signature

HRESULT DocumentFromUri ([in] BSTR uri, [out, retval] IXDocument **prop)

Parameters

[in] BSTR uri
[out, retval] IXDocument ** prop

Details / Examples

Returns the document from uri (path/loid/uuid). The 'uri' param must be in the following form:

  • your_pathname - when using path

  • ?eomid=your_loid - when using loid

  • ?uuid=your_uuid - when using uuid

ExecuteQueryFromUri

Description

Execute e query inside the current methode browser view. It fails for all the other view types.

Signature

HRESULT ExecuteQueryFromUri ([in] BSTR uri, [out, retval] VARIANT_BOOL *pResult)

Parameters

[in] BSTR uri
[out, retval] VARIANT_BOOL * pResult

BrowseFolderFromUri

Description

Browse a folder inside the current methode browser view. It fails for all the other view types.

Signature

HRESULT BrowseFolderFromUri ([in] BSTR uri, [out, retval] VARIANT_BOOL *pResult)

Parameters

[in] BSTR uri
[out, retval] VARIANT_BOOL * pResult

DisableDefaultContextMenu

Description

Disable default context menu.

Signature

HRESULT DisableDefaultContextMenu ([in] BSTR menuItem)

Parameters

[in] BSTR menuItem

AddContextMenuItem

Description

Signature

HRESULT AddContextMenuItem ([in] BSTR menuItem, [in] long Cookie)

Parameters

[in] BSTR menuItem
[in] long Cookie

RunMacro

Description

Signature

HRESULT RunMacro ([in] BSTR script, [out, retval] VARIANT_BOOL *pResult)

Parameters

[in] BSTR script
[out, retval] VARIANT_BOOL * pResult

RunMacroEx

Description

Signature

HRESULT RunMacroEx ([in] BSTR script, [in] BSTR param, [out, retval] VARIANT_BOOL *pResult)

Parameters

[in] BSTR script
[in] BSTR param
[out, retval] VARIANT_BOOL * pResult

SendMessage

Description

Signature

HRESULT SendMessage ([in] BSTR message, [out, retval] VARIANT_BOOL *pResult)

Parameters

[in] BSTR message
[out, retval] VARIANT_BOOL * pResult

Details / Examples

Send a message

  • message: in json format: { "users": ["jhon", "mike"], "subject": "This is the subject", "body": "Hello World!", "attachments": ["http://?eomid=2.0.769054320", "http://?eomid=2.0.769265440"], // a valid eom object uri. "showWindow": true, "priority": "high" }

GetContainerUri

Description

Returns the URI of the main view document.

Signature

HRESULT GetContainerUri (BSTR sFlags, [out, retval] BSTR *pUri)

Parameters

` BSTR sFlags`
[out, retval] BSTR * pUri

SendDbRequest

Description

Signature

HRESULT SendDbRequest ([in] BSTR request, [in] BSTR data, [out, retval] BSTR *pResult)

Parameters

[in] BSTR request
[in] BSTR data
[out, retval] BSTR * pResult

ShowContextCategory

Description

Signature

HRESULT ShowContextCategory ([in] BSTR contextCategory, [out, retval] VARIANT_BOOL *pResult)

Parameters

[in] BSTR contextCategory
[out, retval] VARIANT_BOOL * pResult

MsgBox

Description

Signature

HRESULT MsgBox ([in] BSTR Text, [in] BSTR Caption, [in] int uType, [out, retval] int *pValue)

Parameters

[in] BSTR Text
[in] BSTR Caption
[in] int uType
[out, retval] int * pValue

RecalcRibbonLayout

Description

Signature

HRESULT RecalcRibbonLayout (void)

Parameters

` void `

Properties

DbId

Description

Signature

int DbId

Type

GET

Document

Description

The document associated to this window.

Signature

IXDocument Document

Type

GET

Panels

Description

Signature

IDockablePanes Panels

Type

GET

Users

Description

Returns the collection of the users specific of the current frame Db.

Signature

IUsers Users

Type

GET

Type

Description

Returns the frame type.

Signature

FrameWndType Type

Type

GET

DbSessionString

Description

Returns the database session.

Signature

BSTR DbSessionString

Type

GET

DbSessionLoid

Description

Returns the database session loid.

Signature

BSTR DbSessionLoid

Type

GET

DbSessionMessage

Description

Returns the database session message.

Signature

BSTR DbSessionMessage

Type

GET

BaseUri

Description

Returns the database base Uri.

Signature

BSTR BaseUri

Type

GET

PreviewUri

Description

Returns the Preview Servlet Uri.

Signature

BSTR PreviewUri

Type

GET

PlanExportCfg

Description

Returns the path of the planExport.cfg file.

Signature

BSTR PlanExportCfg

Type

GET

Hwnd

Description

Signature

int Hwnd

Type

GET

TpItemContentTypes

Description

Get list of available content type for topic items.

Signature

BSTR TpItemContentTypes

Type

GET

CorrelationNames

Description

Get list of available correletion types.

Signature

BSTR CorrelationNames

Type

GET

RepositoryName

Description

Returns the current repository name.

Signature

BSTR RepositoryName

Type

GET

RestHelper

Description

Signature

IRestHelper RestHelper

Type

GET

ExternalObjectHelper

Description

Signature

IExternalObjectHelper ExternalObjectHelper

Type

GET

Xsmart::IWindows API Documentation

Functions

GetWindowFromHandle

Description

Returns the active window object from his hwnd.

Signature

HRESULT GetWindowFromHandle ([in] int hwnd, [out, retval] IWindow **prop)

Parameters

[in] int hwnd
[out, retval] IWindow ** prop

Properties

ActiveWindow

Description

Returns the active window object.

Signature

IWindow ActiveWindow

Type

GET

Xsmart::IXDocument API Documentation

Functions

RegisterOnEvents

Description

Signature

HRESULT RegisterOnEvents ([in] long Cookie)

Parameters

[in] long Cookie

SetMaster

Description

Selects the channel master document.

Signature

HRESULT SetMaster ([in] VARIANT_BOOL Val)

Parameters

[in] VARIANT_BOOL Val

RefreshDbData

Description

Clear Cache.

Signature

HRESULT RefreshDbData (void)

Parameters

` void `

GetUri

Description

Returns the URI of the document.

Signature

HRESULT GetUri (int flags, [out, retval] BSTR *pUri)

Parameters

` int flags`
[out, retval] BSTR * pUri

GetAuthorsData

Description

Signature

HRESULT GetAuthorsData ([in] BSTR sRequest, [out, retval] BSTR *pResult)

Parameters

[in] BSTR sRequest
[out, retval] BSTR * pResult

GetMetadataValue

Description

Returns the value of first element.

Signature

HRESULT GetMetadataValue ([in] BSTR xPath, [out, retval] BSTR *pValue)

Parameters

[in] BSTR xPath
[out, retval] BSTR * pValue

setUsageTicket

Description

set usage ticket

Signature

HRESULT setUsageTicket ([in] BSTR pValue, [in] int nTicketID)

Parameters

[in] BSTR pValue
[in] int nTicketID

WorkFlowStatusFromUser

Description

Set workflow status from user.

Signature

HRESULT WorkFlowStatusFromUser ([out, retval] VARIANT_BOOL *pResult)

Parameters

[out, retval] VARIANT_BOOL * pResult

GetContent

Description

Signature

HRESULT GetContent ([in] BSTR sChannel, [in] int fFlags, [out, retval] BSTR *pFileBuffer)

Parameters

[in] BSTR sChannel
[in] int fFlags
[out, retval] BSTR * pFileBuffer

Details / Examples

Get the document contens

  • String that will contain the contents of the file

GetContentEx

Description

Signature

HRESULT GetContentEx ([in] BSTR sOptions, [out, retval] BSTR *pFileBuffer)

Parameters

[in] BSTR sOptions
[out, retval] BSTR * pFileBuffer

SetContent

Description

Signature

HRESULT SetContent ([in] BSTR FileBuffer, [in] int fFlags)

Parameters

[in] BSTR FileBuffer
[in] int fFlags

Details / Examples

Writes a file the the database of the document. This function should be used to write text files

  • String that contains the contents of the file

SetContentEx

Description

Signature

HRESULT SetContentEx ([in] BSTR FileBuffer, [in] BSTR sOptions)

Parameters

[in] BSTR FileBuffer
[in] BSTR sOptions

Details / Examples

Writes a file the the database of the document. This function should be used to write text files

  • String that contains the contents of the file

SaveContent

Description

Save contents of this document.

Signature

HRESULT SaveContent ([in] VARIANT_BOOL bCheckin, [out, retval] VARIANT_BOOL *pResult)

Parameters

[in] VARIANT_BOOL bCheckin
[out, retval] VARIANT_BOOL * pResult

ReloadContent

Description

Reloads the content.

Signature

HRESULT ReloadContent (void)

Parameters

` void `

UpdateContent

Description

Updates the content.

Signature

HRESULT UpdateContent (void)

Parameters

` void `

RecomposeAll

Description

Recomposes all view documents, and refresh window.

Signature

HRESULT RecomposeAll ()

Parameters

CreateOutput

Description

Signature

HRESULT CreateOutput ([in] BSTR sParams, [out] BSTR *pResult)

Parameters

[in] BSTR sParams
[out] BSTR * pResult

CreateOutputFile

Description

Create a pdf file.

Signature

HRESULT CreateOutputFile ([in] BSTR FileName, [in] BSTR OmQueue, [in] BSTR Profile)

Parameters

[in] BSTR FileName
[in] BSTR OmQueue
[in] BSTR Profile

ExecuteDbAction

Description

Execute an action by name.

Signature

HRESULT ExecuteDbAction ([in] BSTR ActionName, [in] BSTR Args, [in] VARIANT_BOOL bCheckin, [out, retval] VARIANT_BOOL *pResult)

Parameters

[in] BSTR ActionName
[in] BSTR Args
[in] VARIANT_BOOL bCheckin
[out, retval] VARIANT_BOOL * pResult

CanRunAddinCmd

Description

Signature

HRESULT CanRunAddinCmd ([in] BSTR AddinName, [in] int nAddinCmd, [out, retval] VARIANT_BOOL *pResult)

Parameters

[in] BSTR AddinName
[in] int nAddinCmd
[out, retval] VARIANT_BOOL * pResult

SetProcess

Description

Set tag process into system attributes.

Signature

HRESULT SetProcess ([in] BSTR strProcessName, [in] int nProcessType)

Parameters

[in] BSTR strProcessName
[in] int nProcessType

ResolveSysVar

Description

Resolves the system variable.

Signature

HRESULT ResolveSysVar ([in] BSTR Label, [in] BSTR Format, [out, retval] BSTR *pValue)

Parameters

[in] BSTR Label
[in] BSTR Format
[out, retval] BSTR * pValue

AssignToFromUser

Description

Assign this document.

Signature

HRESULT AssignToFromUser ([out, retval] VARIANT_BOOL *pResult)

Parameters

[out, retval] VARIANT_BOOL * pResult

CheckOut

Description

Checkout.

Signature

HRESULT CheckOut ([out, retval] VARIANT_BOOL *pValue)

Parameters

[out, retval] VARIANT_BOOL * pValue

CheckIn

Description

Checkin (Prompts for save if document modified)

Signature

HRESULT CheckIn ([out, retval] VARIANT_BOOL *pValue)

Parameters

[out, retval] VARIANT_BOOL * pValue

ForceUnlock

Description

Force Unlock.

Signature

HRESULT ForceUnlock ([out, retval] VARIANT_BOOL *pValue)

Parameters

[out, retval] VARIANT_BOOL * pValue

ExportTo

Description

Export to local file.

Signature

HRESULT ExportTo ([in] BSTR sUri, [in] BSTR sFormatName, [out, retval] VARIANT_BOOL *pResult)

Parameters

[in] BSTR sUri
[in] BSTR sFormatName
[out, retval] VARIANT_BOOL * pResult

ImportFrom

Description

Update contents from local file.

Signature

HRESULT ImportFrom ([in] BSTR sUri, [in] BSTR sFormatName, [in] VARIANT_BOOL bDeleteSource, [out, retval] VARIANT_BOOL *pResult)

Parameters

[in] BSTR sUri
[in] BSTR sFormatName
[in] VARIANT_BOOL bDeleteSource
[out, retval] VARIANT_BOOL * pResult

Open

Description

Open the currently selected document within the appropriate editor.

Signature

HRESULT Open ([in] VARIANT_BOOL bReadOnly, [out, retval] VARIANT_BOOL *pResult)

Parameters

[in] VARIANT_BOOL bReadOnly
[out, retval] VARIANT_BOOL * pResult

UpdateFromSource

Description

Signature

HRESULT UpdateFromSource ([in] BSTR sSourceUri, [out, retval] VARIANT_BOOL *pResult)

Parameters

[in] BSTR sSourceUri
[out, retval] VARIANT_BOOL * pResult

Touch

Description

Update last modification time.

Signature

HRESULT Touch ([out, retval] VARIANT_BOOL *pResult)

Parameters

[out, retval] VARIANT_BOOL * pResult

Rename

Description

Rename document.

Signature

HRESULT Rename ([in] BSTR sNewName, [out, retval] VARIANT_BOOL *pResult)

Parameters

[in] BSTR sNewName
[out, retval] VARIANT_BOOL * pResult

GetFormatRole

Description

Get document’s format role.

Signature

HRESULT GetFormatRole ([in] BSTR sRoleName, [out, retval] BSTR *pRoleBuffer)

Parameters

[in] BSTR sRoleName
[out, retval] BSTR * pRoleBuffer

SetFormatRole

Description

Set document’s format role.

Signature

HRESULT SetFormatRole ([in] BSTR sRoleName, [in] BSTR sRoleBuffer, [out, retval] VARIANT_BOOL *pResult)

Parameters

[in] BSTR sRoleName
[in] BSTR sRoleBuffer
[out, retval] VARIANT_BOOL * pResult

GetDbActionList

Description

Signature

HRESULT GetDbActionList ([out, retval] BSTR *pData)

Parameters

[out, retval] BSTR * pData

GetFontList

Description

Return the page font list.

Signature

HRESULT GetFontList ([out, retval] BSTR *pJsonData)

Parameters

[out, retval] BSTR * pJsonData

GetColorList

Description

Return the Colorlist.

Signature

HRESULT GetColorList ([out, retval] BSTR *pJsonData)

Parameters

[out, retval] BSTR * pJsonData

GetColorGradientData

Description

Signature

HRESULT GetColorGradientData ([in] BSTR sColorName, [out, retval] BSTR *pJsonData)

Parameters

[in] BSTR sColorName
[out, retval] BSTR * pJsonData

GetPrivateColorList

Description

Signature

HRESULT GetPrivateColorList ([out, retval] BSTR *pJsonData)

Parameters

[out, retval] BSTR * pJsonData

IsModifyable

Description

Signature

HRESULT IsModifyable ([out, retval] VARIANT_BOOL *pResult)

Parameters

[out, retval] VARIANT_BOOL * pResult

IsPageDoc

Description

Signature

HRESULT IsPageDoc ([out, retval] VARIANT_BOOL *pResult)

Parameters

[out, retval] VARIANT_BOOL * pResult

GetAccessoryItemList

Description

Return AccessoryItem list.

Signature

HRESULT GetAccessoryItemList ([out, retval] BSTR *pJsonData)

Parameters

[out, retval] BSTR * pJsonData

GetLineEndingItemList

Description

Return LineEnding Item list.

Signature

HRESULT GetLineEndingItemList ([out, retval] BSTR *pJsonData)

Parameters

[out, retval] BSTR * pJsonData

GetPredefinedEffectsList

Description

Return the list of predefined effects.

Signature

HRESULT GetPredefinedEffectsList (short scope, [out, retval] BSTR *pJsonData)

Parameters

` short scope`
[out, retval] BSTR * pJsonData

GetCollaborators

Description

Returns the object collaborators name semi-comma separated.

Signature

HRESULT GetCollaborators ([out, retval] BSTR *pValue)

Parameters

[out, retval] BSTR * pValue

SetCollaborators

Description

Set the object collaborators name semi-comma separated.

Signature

HRESULT SetCollaborators ([in] BSTR sValue, [out, retval] VARIANT_BOOL *pResult)

Parameters

[in] BSTR sValue
[out, retval] VARIANT_BOOL * pResult

ReplaceExternalSourceData

Description

Signature

HRESULT ReplaceExternalSourceData ([in] BSTR sSourceData, [in] BSTR sDestData, [out, retval] VARIANT_BOOL *pResult)

Parameters

[in] BSTR sSourceData
[in] BSTR sDestData
[out, retval] VARIANT_BOOL * pResult

GetChannelCopyList

Description

Return the list of alternate copies to display in the channel dropdown menu.

Signature

HRESULT GetChannelCopyList ([out, retval] BSTR *pData)

Parameters

[out, retval] BSTR * pData

CreateChannelCopy

Description

Signature

HRESULT CreateChannelCopy ([in] BSTR sData, [out, retval] BSTR *pResult)

Parameters

[in] BSTR sData
[out, retval] BSTR * pResult

CanDownloadOffline

Description

Signature

HRESULT CanDownloadOffline ([out, retval] VARIANT_BOOL *pResult)

Parameters

[out, retval] VARIANT_BOOL * pResult

DownloadOffline

Description

Signature

HRESULT DownloadOffline ([out, retval] VARIANT_BOOL *pResult)

Parameters

[out, retval] VARIANT_BOOL * pResult

ExportData

Description

Signature

HRESULT ExportData ([in] BSTR sRequest, [out, retval] BSTR *pResult)

Parameters

[in] BSTR sRequest
[out, retval] BSTR * pResult

HasTemporaryPreviewFiles

Description

Signature

HRESULT HasTemporaryPreviewFiles ([out, retval] VARIANT_BOOL *pResult)

Parameters

[out, retval] VARIANT_BOOL * pResult

SelectTrackerTool

Description

Select a tracker tool.

Signature

HRESULT SelectTrackerTool ([in] BSTR sData, [out, retval] VARIANT_BOOL *pResult)

Parameters

[in] BSTR sData
[out, retval] VARIANT_BOOL * pResult

UpdateExternalSources

Description

Signature

HRESULT UpdateExternalSources ([in] BSTR sData, [out, retval] VARIANT_BOOL *pResult)

Parameters

[in] BSTR sData
[out, retval] VARIANT_BOOL * pResult

GetPureText

Description

Signature

HRESULT GetPureText ([out, retval] BSTR *pText)

Parameters

[out, retval] BSTR * pText

TagPureText

Description

Signature

HRESULT TagPureText ([in] BSTR sData)

Parameters

[in] BSTR sData

ClearPureText

Description

Signature

HRESULT ClearPureText ([in] BSTR sData)

Parameters

[in] BSTR sData

SelectTextElement

Description

Signature

HRESULT SelectTextElement ([in] BSTR sData, [out, retval] VARIANT_BOOL *pResult)

Parameters

[in] BSTR sData
[out, retval] VARIANT_BOOL * pResult

AnnotateTextElement

Description

Signature

HRESULT AnnotateTextElement ([in] BSTR sData, [out, retval] VARIANT_BOOL *pResult)

Parameters

[in] BSTR sData
[out, retval] VARIANT_BOOL * pResult

Properties

Selection

Description

Signature

ISelection Selection

Type

GET

Master

Description

Signature

IXDocument Master

Type

GET

Dirty

Description

Checks/set the modified status of the document.

Signature

VARIANT_BOOL Dirty

Type

GET SET

PathName

Description

Returns the full path of the document.

Signature

BSTR PathName

Type

GET

Name

Description

Returns the file name of the document.

Signature

BSTR Name

Type

GET

Loid

Description

Returns the loid of the document.

Signature

BSTR Loid

Type

GET

UUid

Description

Returns the UUid of the document.

Signature

BSTR UUid

Type

GET

StoryFamilyID

Description

Returns the Story Family id of the document.

Signature

BSTR StoryFamilyID

Type

GET

DBid

Description

Returns the DBid of the document.

Signature

int DBid

Type

GET

Creator

Description

Returns the creator name.

Signature

BSTR Creator

Type

GET

Owner

Description

Returns the owner name.

Signature

BSTR Owner

Type

GET

TimeCreated

Description

Returns the creation time.

Signature

DATE TimeCreated

Type

GET

LastModifier

Description

Returns the last modifier name.

Signature

BSTR LastModifier

Type

GET

TimeLastModified

Description

Returns the last modification time.

Signature

DATE TimeLastModified

Type

GET

Locker

Description

Returns the locker name.

Signature

BSTR Locker

Type

GET

TimeLocked

Description

Returns the lock time.

Signature

DATE TimeLocked

Type

GET

ContentModifier

Description

Returns the content modifier name.

Signature

BSTR ContentModifier

Type

GET

TimeContentModified

Description

Returns the content modified time.

Signature

DATE TimeContentModified

Type

GET

ObjectType

Description

Returns the EOM object type of the open (or selected) document.

Signature

BSTR ObjectType

Type

GET

ContentType

Description

Signature

BSTR ContentType

Type

GET

ChildDocumentType

Description

Child document type.

Signature

BSTR ChildDocumentType

Type

GET

OwnerTeam

Description

Returns the name of the owner team.

Signature

BSTR OwnerTeam

Type

GET

Size

Description

Size of content document.

Signature

int Size

Type

GET

ProductName

Description

Returns the name of the product.

Signature

BSTR ProductName

Type

GET

ChannelIdentifier

Description

Returns the name of the selected product/edition.

Signature

BSTR ChannelIdentifier

Type

GET SET

IssueDate

Description

Returns the issue date of the product.

Signature

DATE IssueDate

Type

GET

IssueNumber

Description

Returns the issue number of the product.

Signature

int IssueNumber

Type

GET

IssueNumberName

Description

Returns the issue symbolic name of the product.

Signature

BSTR IssueNumberName

Type

GET

WorkFolder

Description

Returns the name of the workfolder.

Signature

BSTR WorkFolder

Type

GET

TemplateName

Description

Returns the template name.

Signature

BSTR TemplateName

Type

GET SET

Metadata

Description

Returns the attributes (metadata) of the object.

Signature

BSTR Metadata

Type

GET SET

SysAttributes

Description

Returns the system attributes of the object.

Signature

BSTR SysAttributes

Type

GET SET

VirtualAttributes

Description

Returns the virtual attributes of the object.

Signature

BSTR VirtualAttributes

Type

GET

UsageTickets

Description

Returns the usage tickets of the object.

Signature

BSTR UsageTickets

Type

GET

WorkFlowStatus

Description

Returns the workflow status.

Signature

BSTR WorkFlowStatus

Type

GET SET

Description

Description

Returns the object description.

Signature

BSTR Description

Type

GET SET

DbActions

Description

Returns the availabe actions.

Signature

BSTR DbActions

Type

GET

CompoundDocuments

Description

Returns the array of the compund documents.

Signature

BSTR CompoundDocuments

Type

GET

Next

Description

Signature

VARIANT_BOOL Next

Type

GET

Prev

Description

Signature

VARIANT_BOOL Prev

Type

GET

AssignedUsers

Description

Returns the assigned users.

Signature

BSTR AssignedUsers

Type

GET SET

SourceDocument

Description

Get source object.

Signature

BSTR SourceDocument

Type

GET

PageAccessoriesFileName

Description

Returns the filename of the PageAccessories name.

Signature

BSTR PageAccessoriesFileName

Type

GET

ExternalAssetsPathName

Description

Signature

BSTR ExternalAssetsPathName

Type

GET

UniquenessString

Description

Signature

BSTR UniquenessString

Type

GET

ExternalSourceUris

Description

Signature

BSTR ExternalSourceUris

Type

GET

Xsmart::IDocuments API Documentation

Functions

Item

Description

Returns the document from index.

Signature

HRESULT Item ([in] long index, [out, retval] IXDocument **pDoc)

Parameters

[in] long index
[out, retval] IXDocument ** pDoc

Properties

ActiveDocument

Description

Signature

IXDocument ActiveDocument

Type

GET

ActiveEditor

Description

Signature

IDocumentText ActiveEditor

Type

GET

Count

Description

Returns the number of open documents.

Signature

long Count

Type

GET

Xsmart::IDocumentDesktop API Documentation

Functions

Properties

Xsmart::IDocumentText API Documentation

Functions

ReloadEmbargoData

Description

Reload embargo data.

Signature

HRESULT ReloadEmbargoData (void)

Parameters

` void `

CreateXsmileChainedDoc

Description

Create a new chain.

Signature

HRESULT CreateXsmileChainedDoc ([in] BSTR sChainTag, [in] BSTR sBodyContentItem, [in] BSTR sBodyFragment, [in] BSTR sOptions, [out, retval] BSTR *pNewDocName)

Parameters

[in] BSTR sChainTag
[in] BSTR sBodyContentItem
[in] BSTR sBodyFragment
[in] BSTR sOptions
[out, retval] BSTR * pNewDocName

GetLinkingContainers

Description

Get the list of conatainers that link this document.

Signature

HRESULT GetLinkingContainers ([in] BSTR sType, [out, retval] IFOIterator **pContainers)

Parameters

[in] BSTR sType
[out, retval] IFOIterator ** pContainers

GetChildDocuments

Description

Get the inline document iterator.

Signature

HRESULT GetChildDocuments ([in] BSTR sType, [out, retval] IFOIterator **pInlineDocuments)

Parameters

[in] BSTR sType
[out, retval] IFOIterator ** pInlineDocuments

GetInlineDocuments

Description

Get the inline document iterator.

Signature

HRESULT GetInlineDocuments ([in] VARIANT_BOOL bExternalStories, [out, retval] IFOIterator **pInlineDocuments)

Parameters

[in] VARIANT_BOOL bExternalStories
[out, retval] IFOIterator ** pInlineDocuments

IsChildDocumentMarked

Description

Signature

HRESULT IsChildDocumentMarked ([in] BSTR sClassName, [out, retval] VARIANT_BOOL *pResult)

Parameters

[in] BSTR sClassName
[out, retval] VARIANT_BOOL * pResult

MarkChildDocument

Description

Signature

HRESULT MarkChildDocument ([in] BSTR sClassName, VARIANT_BOOL bMark, [out, retval] VARIANT_BOOL *pResult)

Parameters

[in] BSTR sClassName
` VARIANT_BOOL bMark`
[out, retval] VARIANT_BOOL * pResult

GetChannelList

Description

Return all information about channels.

Signature

HRESULT GetChannelList ([out, retval] BSTR *pData)

Parameters

[out, retval] BSTR * pData

GetEditionList

Description

Signature

HRESULT GetEditionList ([in] BSTR channelName, [out, retval] BSTR *pData)

Parameters

[in] BSTR channelName
[out, retval] BSTR * pData

GetAlternateStyleList

Description

Signature

HRESULT GetAlternateStyleList ([in] BSTR channelName, [out, retval] BSTR *pData)

Parameters

[in] BSTR channelName
[out, retval] BSTR * pData

GetDefaultAltStyle

Description

Signature

HRESULT GetDefaultAltStyle ([in] BSTR channelName, [in] BSTR editionName, [out, retval] BSTR *pData)

Parameters

[in] BSTR channelName
[in] BSTR editionName
[out, retval] BSTR * pData

SetChannel

Description

Signature

HRESULT SetChannel ([in] BSTR channelName, [in] BSTR editionName, [in] BSTR alternateStyle)

Parameters

[in] BSTR channelName
[in] BSTR editionName
[in] BSTR alternateStyle

Properties

TagWizardFile

Description

Sets the tag wizard file.

Signature

BSTR TagWizardFile

Type

SET

ShapeFile

Description

Sets a shape file.

Signature

BSTR ShapeFile

Type

SET

ShapeWidth

Description

Sets the shape width.

Signature

BSTR ShapeWidth

Type

SET

ShapeHeight

Description

Sets the shape height.

Signature

BSTR ShapeHeight

Type

SET

XslTemplates

Description

Returns the temnplate name.

Signature

BSTR XslTemplates

Type

GET

ChannelName

Description

Returns the active channel name.

Signature

BSTR ChannelName

Type

GET SET

AlternateStyle

Description

Set the alternate style name.

Signature

BSTR AlternateStyle

Type

GET SET

Xsmart::IDocumentPage API Documentation

Functions

GetExportDataPath

Description

Returns the path of the export data file.

Signature

HRESULT GetExportDataPath ([out, retval] BSTR *pFilePath)

Parameters

[out, retval] BSTR * pFilePath

GetExportContentPath

Description

Returns the path of the export file.

Signature

HRESULT GetExportContentPath ([in] int contentType, [out, retval] BSTR *pFilePath)

Parameters

[in] int contentType
[out, retval] BSTR * pFilePath

WritePdf

Description

Signature

HRESULT WritePdf ([in] BSTR Name, [in] BSTR Profile, [in] BSTR Type, [in] int bMultiTruck, [out, retval] BSTR *pUrl)

Parameters

[in] BSTR Name
[in] BSTR Profile
[in] BSTR Type
[in] int bMultiTruck
[out, retval] BSTR * pUrl

Details / Examples

Writes a pdf of the page

  • Complete path name of the pdf file to generate

  • Output profile to use

  • On exit contains the loid of the generate pdf Returns the loid of the created pdf

GetEditionList

Description

Returns the edition list.

Signature

HRESULT GetEditionList ([out, retval] BSTR *pData)

Parameters

[out, retval] BSTR * pData

SetEdition

Description

Set the current edition by name.

Signature

HRESULT SetEdition ([in] BSTR editionName)

Parameters

[in] BSTR editionName

GetGridList

Description

Signature

HRESULT GetGridList ([out, retval] BSTR *pJsonData)

Parameters

[out, retval] BSTR * pJsonData

GetFormatList

Description

Signature

HRESULT GetFormatList ([out, retval] BSTR *pJsonData)

Parameters

[out, retval] BSTR * pJsonData

LoadContents

Description

Signature

HRESULT LoadContents ([in] int plm)

Parameters

[in] int plm

Details / Examples

Load the contents of the page. For performance reasons Xsmile loads the contents of a page when it is first displayed, so call this function explicitly before using methods that act on the page contents (for example the list of stories connected to a page).

  • plm = 0 - load all contents

UnloadContents

Description

Unloads the contents of the page.

Signature

HRESULT UnloadContents ()

Parameters

SetProperty

Description

Signature

HRESULT SetProperty ([in] BSTR Name, [in] BSTR Value)

Parameters

[in] BSTR Name
[in] BSTR Value

Details / Examples

Set a user defined persistent property for this page

  • Property Name

  • Property Value

GetProperty

Description

Signature

HRESULT GetProperty ([in] BSTR Name, [out, retval] BSTR *Value)

Parameters

[in] BSTR Name
[out, retval] BSTR * Value

Details / Examples

Retrieves a user defined persistent property that was set for this page

  • Property Name

  • Property Value

GetUserVars

Description

Returns the user variables.

Signature

HRESULT GetUserVars ([out] BSTR *pLabels, [out] BSTR *pDomAttributes)

Parameters

[out] BSTR * pLabels
[out] BSTR * pDomAttributes

getItemStatistics

Description

Returns the statistics.

Signature

HRESULT getItemStatistics ([out] int *pText, [out] int *pAds, [out] int *pPictures, [out] int *pGraphics)

Parameters

[out] int * pText
[out] int * pAds
[out] int * pPictures
[out] int * pGraphics

getItemStatisticsEx

Description

Returns the statistics.

Signature

HRESULT getItemStatisticsEx ([out, retval] BSTR *pJsonValue)

Parameters

[out, retval] BSTR * pJsonValue

GetPageData

Description

Signature

HRESULT GetPageData ([in] BSTR inData, [out, retval] BSTR *outData)

Parameters

[in] BSTR inData
[out, retval] BSTR * outData

Properties

ProductPage

Description

Signature

IProductPage ProductPage

Type

GET

Title

Description

Returns the title of this page.

Signature

BSTR Title

Type

GET SET

Section

Description

Returns the name of the page section.

Signature

BSTR Section

Type

GET SET

SubSection

Description

Returns the name of the page subsection.

Signature

BSTR SubSection

Type

GET

AdSection

Description

Returns the name of the ad section.

Signature

BSTR AdSection

Type

GET

Folio

Description

Returns the name of the folio associated to the page.

Signature

BSTR Folio

Type

GET SET

Color

Description

Returns the page color.

Signature

BSTR Color

Type

GET SET

PlanID

Description

Returns the id of the page in the plan.

Signature

BSTR PlanID

Type

GET

Href

Description

Returns the address (path) of the linked page.

Signature

BSTR Href

Type

GET

ExportWorkFlowStatus

Description

Returns the export workflow status.

Signature

BSTR ExportWorkFlowStatus

Type

GET

Deadline

Description

Returns the deadline for this page.

Signature

DATE Deadline

Type

GET

ReleaseTime

Description

Returns the time the page was output.

Signature

DATE ReleaseTime

Type

GET

Number

Description

Returns the page number.

Signature

BSTR Number

Type

GET

SequenceNumber

Description

Returns the sequence number.

Signature

BSTR SequenceNumber

Type

GET

InsertSection

Description

Returns the name of eventual plan insert section.

Signature

BSTR InsertSection

Type

GET

Grid

Description

Set the page grid.

Signature

BSTR Grid

Type

GET SET

Style

Description

Returns the page style.

Signature

BSTR Style

Type

GET

X

Description

Returns the x-coordinate.

Signature

double X

Type

GET

Y

Description

Returns the y-coordinate.

Signature

double Y

Type

GET

Width

Description

Returns the width.

Signature

double Width

Type

GET

Height

Description

Returns the height.

Signature

double Height

Type

GET

LinkedPagePart

Description

Returns the linked page part.

Signature

int LinkedPagePart

Type

GET

LinkedPageTruck

Description

Returns the linked page truck.

Signature

int LinkedPageTruck

Type

GET

ColorSpace

Description

Signature

xsColorSpaces ColorSpace

Type

GET

VirtualType

Description

Returns inheritance type (if any)

Signature

int VirtualType

Type

GET

ProperShapes

Description

Returns true if this page can have shapes.

Signature

VARIANT_BOOL ProperShapes

Type

GET

MasterPage

Description

If the page is virtual returns the page it inherits from.

Signature

IProductPage MasterPage

Type

GET

BaseMasterPage

Description

Returns the main page (if page virtual returns page chain head, otherwise this page)

Signature

IProductPage BaseMasterPage

Type

GET

Visible

Description

Signature

VARIANT_BOOL Visible

Type

GET

Selected

Description

Returns TRUE if the page is currently selected.

Signature

VARIANT_BOOL Selected

Type

GET

Book

Description

Returns the book this page belongs to.

Signature

IProductBook Book

Type

GET

Edition

Description

Returns the edition this page belongs to.

Signature

IEdition Edition

Type

GET

InheritancePath

Description

Returns the edition’s path.

Signature

BSTR InheritancePath

Type

GET

VirtualPages

Description

Signature

IFOIterator VirtualPages

Type

GET

PureVirtualPages

Description

Signature

IFOIterator PureVirtualPages

Type

GET

PartPages

Description

getPartPages

Signature

IFOIterator PartPages

Type

GET

Plates

Description

Returns the list of plates that contain any page-part of this page.

Signature

IFOIterator Plates

Type

GET

NewsItems

Description

Returns the list of newsitems that are connected to this page.

Signature

IFOIterator NewsItems

Type

GET

Stories

Description

Returns the list of stories that are connected to this page.

Signature

IFOIterator Stories

Type

GET

OutputQueue

Description

Returns the name of the last output queue on which this page has been outputted.

Signature

BSTR OutputQueue

Type

GET

PlanFileName

Description

Returns the plan file path.

Signature

BSTR PlanFileName

Type

GET

Spreads

Description

Signature

IFOIterator Spreads

Type

GET

Xsmart::IDocumentTopic API Documentation

Functions

SelectItem

Description

Select the item by id.

Signature

HRESULT SelectItem ([in] BSTR sID)

Parameters

[in] BSTR sID

Properties

DocumentData

Description

Returns the document data in JSON format.

Signature

BSTR DocumentData

Type

GET

AvailableContentTypes

Description

Signature

BSTR AvailableContentTypes

Type

GET

Xsmart::IDocumentDwp API Documentation

Functions

UnlinkItem

Description

Unlink item.

Signature

HRESULT UnlinkItem ([in] BSTR sItemLoid, [in] BSTR sOptions, [out, retval] VARIANT_BOOL *pResult)

Parameters

[in] BSTR sItemLoid
[in] BSTR sOptions
[out, retval] VARIANT_BOOL * pResult

SwapItems

Description

Swap items.

Signature

HRESULT SwapItems ([in] BSTR sLoidFirst, [in] BSTR sLoidSecond, [out, retval] VARIANT_BOOL *pResult)

Parameters

[in] BSTR sLoidFirst
[in] BSTR sLoidSecond
[out, retval] VARIANT_BOOL * pResult

MoveItem

Description

Signature

HRESULT MoveItem ([in] BSTR sData, [out, retval] VARIANT_BOOL *pResult)

Parameters

[in] BSTR sData
[out, retval] VARIANT_BOOL * pResult

SelectNextItem

Description

Signature

HRESULT SelectNextItem ([in] BSTR sData, [out, retval] VARIANT_BOOL *pResult)

Parameters

[in] BSTR sData
[out, retval] VARIANT_BOOL * pResult

Properties

DwpZones

Description

Get dwp zones.

Signature

IFOIterator DwpZones

Type

GET

Edition

Description

Returns the edition this page belongs to.

Signature

IEdition Edition

Type

GET

Xsmart::IDwpItem API Documentation

Functions

GetPureText

Description

Signature

HRESULT GetPureText ([out, retval] BSTR *Text)

Parameters

[out, retval] BSTR * Text

Properties

TemplateName

Description

Get dwp item template name.

Signature

BSTR TemplateName

Type

GET

Position

Description

Get dwp item position.

Signature

int Position

Type

GET

LinkName

Description

Get dwp item link name.

Signature

BSTR LinkName

Type

GET

LinkData

Description

Get dwp link extra data.

Signature

BSTR LinkData ([in] BSTR sRootName)

Type

GET SET

Document

Description

Get dwp item linked document.

Signature

IXDocument Document

Type

GET

Xsmart::IDwpPartPage API Documentation

Functions

Properties

Name

Description

Get the dwp zone name.

Signature

BSTR Name

Type

GET

MaxItems

Description

Get the dwp zone max items.

Signature

int MaxItems

Type

GET

StyleName

Description

Get the dwp zone alternate style name.

Signature

BSTR StyleName

Type

GET SET

DwpItems

Description

Get the dwp zone items.

Signature

IFOIterator DwpItems

Type

GET

Xsmart::ISelection API Documentation

Functions

ClearSelection

Description

Signature

HRESULT ClearSelection (void)

Parameters

` void `

SelectItemFromLoid

Description

Signature

HRESULT SelectItemFromLoid ([in] BSTR sLoid, [out, retval] VARIANT_BOOL *pResult)

Parameters

[in] BSTR sLoid
[out, retval] VARIANT_BOOL * pResult

Properties

ViewType

Description

Get the current object view type (if any)

Signature

BSTR ViewType

Type

GET

Document

Description

Get the linked story document interface.

Signature

IDispatch Document

Type

GET

EmbeddedDocument

Description

Get the embedded document interface.

Signature

IDispatch EmbeddedDocument

Type

GET

Layout

Description

Get the layout interface.

Signature

ILayout Layout

Type

GET

TextView

Description

Get the textview interface.

Signature

ITextView TextView

Type

GET

TypoModifier

Description

Signature

ITypoModifier TypoModifier

Type

GET

PictureView

Description

Get the pictureview interface.

Signature

IPictureView PictureView

Type

GET

ProductPage

Description

Get the ProductPage interface.

Signature

IProductPage ProductPage

Type

GET

Next

Description

Move to next item in a multiselection.

Signature

VARIANT_BOOL Next

Type

GET

Prev

Description

Move to previous item in a multiselection.

Signature

VARIANT_BOOL Prev

Type

GET

Count

Description

Returns the number of selections.

Signature

long Count

Type

GET

Item

Description

Signature

IXDocument Item ([in] long Index)

Type

GET

Xsmart::IUser API Documentation

Functions

GetEditorialGroups

Description

Get users groups.

Signature

HRESULT GetEditorialGroups ([out, retval] BSTR *pTeams)

Parameters

[out, retval] BSTR * pTeams

GetEditorialTeams

Description

Get users teams.

Signature

HRESULT GetEditorialTeams ([out, retval] BSTR *pTeams)

Parameters

[out, retval] BSTR * pTeams

GetDefaultEditorialTeam

Description

Get users teams.

Signature

HRESULT GetDefaultEditorialTeam ([out, retval] BSTR *pDefaultTeam)

Parameters

[out, retval] BSTR * pDefaultTeam

GetTeamProducts

Description

Get team products.

Signature

HRESULT GetTeamProducts ([in] BSTR sTeam, [out, retval] BSTR *pProducts)

Parameters

[in] BSTR sTeam
[out, retval] BSTR * pProducts

GetDefaultTeamProduct

Description

Get default team product.

Signature

HRESULT GetDefaultTeamProduct ([in] BSTR sTeam, [out, retval] BSTR *pDefaultProduct)

Parameters

[in] BSTR sTeam
[out, retval] BSTR * pDefaultProduct

GetProductEditions

Description

Get editions.

Signature

HRESULT GetProductEditions ([in] BSTR sTeam, [in] BSTR sProduct, [out, retval] BSTR *pEditions)

Parameters

[in] BSTR sTeam
[in] BSTR sProduct
[out, retval] BSTR * pEditions

GetProductWorkFolders

Description

Get workfolders.

Signature

HRESULT GetProductWorkFolders ([in] BSTR sTeam, [in] BSTR sProduct, [out, retval] BSTR *pWorkFolders)

Parameters

[in] BSTR sTeam
[in] BSTR sProduct
[out, retval] BSTR * pWorkFolders

GetDefaultWorkFolder

Description

Get default workfolder.

Signature

HRESULT GetDefaultWorkFolder ([in] BSTR sTeam, [in] BSTR sProduct, [out, retval] BSTR *pWorkFolder)

Parameters

[in] BSTR sTeam
[in] BSTR sProduct
[out, retval] BSTR * pWorkFolder

GetProductNextDate

Description

Get next valid date for the give product.

Signature

HRESULT GetProductNextDate ([in] BSTR sTeam, [in] BSTR sProduct, [out, retval] BSTR *pDate)

Parameters

[in] BSTR sTeam
[in] BSTR sProduct
[out, retval] BSTR * pDate

GetData

Description

Signature

HRESULT GetData ([in] BSTR sDataName, [out, retval] BSTR *pDataValue)

Parameters

[in] BSTR sDataName
[out, retval] BSTR * pDataValue

SetData

Description

Signature

HRESULT SetData ([in] BSTR sDataName, [in] BSTR sDataValue)

Parameters

[in] BSTR sDataName
[in] BSTR sDataValue

changeUserPicture

Description

Signature

HRESULT changeUserPicture ([out, retval] VARIANT_BOOL *pResult)

Parameters

[out, retval] VARIANT_BOOL * pResult

displayUserProfile

Description

Signature

HRESULT displayUserProfile ()

Parameters

sendDbMessage

Description

Signature

HRESULT sendDbMessage ()

Parameters

Properties

LoginName

Description

Returns the user login name.

Signature

BSTR LoginName

Type

GET

FullName

Description

Returns the use full name.

Signature

BSTR FullName

Type

GET

Metadata

Description

Returns the attributes (metadata) of the object.

Signature

BSTR Metadata

Type

GET SET

SysAttributes

Description

Returns the system attributes of the object.

Signature

BSTR SysAttributes

Type

GET SET

isLogged

Description

Returns the user status.

Signature

BOOL isLogged

Type

GET

Tasks

Description

Returns the collection of all task of user.

Signature

ITasks Tasks

Type

GET

EventCallback

Description

Signature

VARIANT EventCallback

Type

SET

Xsmart::IUsers API Documentation

Functions

GetUserListAsync

Description

Signature

HRESULT GetUserListAsync ([in] VARIANT vCallback)

Parameters

[in] VARIANT vCallback

Properties

ActiveUser

Description

Returns the active user object.

Signature

IUser ActiveUser

Type

GET

CountEx

Description

Signature

long CountEx ([in] long dbId)

Type

GET

Count

Description

Signature

long Count

Type

GET

User

Description

Signature

IUser User ([in] BSTR loginName)

Type

GET

UserEx

Description

Signature

IUser UserEx ([in] BSTR loginName,[in] long dbId)

Type

GET

UserAtEx

Description

Signature

IUser UserAtEx ([in] long index,[in] long dbId)

Type

GET

UserAt

Description

Signature

IUser UserAt ([in] long index)

Type

GET

EditorialTeams

Description

Signature

BSTR EditorialTeams

Type

GET

CurrentUser

Description

Signature

BSTR CurrentUser

Type

GET

SpecificUser

Description

Signature

BSTR SpecificUser ([in] BSTR loginName)

Type

GET

Groups

Description

Signature

BSTR Groups

Type

GET

GroupMembers

Description

Signature

BSTR GroupMembers ([in] BSTR group,[in] BSTR refinement)

Type

GET

GroupMembersSubVector

Description

Signature

BSTR GroupMembersSubVector ([in] BSTR group,[in] int start,[in] int end)

Type

GET

Xsmart::ITextView API Documentation

Functions

GetText

Description

Get the currently selected text.

Signature

HRESULT GetText ([in] int fFlags, [out, retval] BSTR *Text)

Parameters

[in] int fFlags
[out, retval] BSTR * Text

SetText

Description

Replace the selected text, if no text is selected it is inserted at the current cursor location.

Signature

HRESULT SetText ([in] BSTR Text, [in] VARIANT_BOOL bXml, [in] VARIANT_BOOL bKeepSelected)

Parameters

[in] BSTR Text
[in] VARIANT_BOOL bXml
[in] VARIANT_BOOL bKeepSelected

GetPureText

Description

Signature

HRESULT GetPureText ([in] long Start, [in] long Size, [out, retval] BSTR *Text)

Parameters

[in] long Start
[in] long Size
[out, retval] BSTR * Text

GetPureTextLen

Description

Signature

HRESULT GetPureTextLen ([in, out] long *Size)

Parameters

[in, out] long * Size

SetPureText

Description

Signature

HRESULT SetPureText (long Start, long Size, [in] BSTR Text)

Parameters

` long Start`
` long Size`
[in] BSTR Text

HighlightPureText

Description

Signature

HRESULT HighlightPureText ([in] long Start, [in] long Size)

Parameters

[in] long Start
[in] long Size

GetPureTextSelection

Description

Signature

HRESULT GetPureTextSelection ([in, out] long *Start, [in, out] long *Size)

Parameters

[in, out] long * Start
[in, out] long * Size

GetPureTextSelectionEx

Description

Signature

HRESULT GetPureTextSelectionEx ([out, retval] BSTR *pData)

Parameters

[out, retval] BSTR * pData

GetPureParaTextSelection

Description

Signature

HRESULT GetPureParaTextSelection ([out, retval] BSTR *pData)

Parameters

[out, retval] BSTR * pData

RemoveTag

Description

Remove the selection tag (or the given one)

Signature

HRESULT RemoveTag ([in] BSTR sTag, [in] int fFlags)

Parameters

[in] BSTR sTag
[in] int fFlags

ReplaceTag

Description

Replace a tag with another at given caret position.

Signature

HRESULT ReplaceTag ([in] BSTR sTag, [in] BSTR sNewTag)

Parameters

[in] BSTR sTag
[in] BSTR sNewTag

ToggleTag

Description

Toggle tag, the return value indicates if was inserted or deleted.

Signature

HRESULT ToggleTag ([in] BSTR sTag, [out, retval] VARIANT_BOOL *pResult)

Parameters

[in] BSTR sTag
[out, retval] VARIANT_BOOL * pResult

HasTag

Description

Check for tag presence at cursor position.

Signature

HRESULT HasTag ([in] BSTR sTag, [out, retval] VARIANT_BOOL *pResult)

Parameters

[in] BSTR sTag
[out, retval] VARIANT_BOOL * pResult

ReplaceTagFragment

Description

Replace the specified tag tree with the given fragment, the tag itself is replaced.

Signature

HRESULT ReplaceTagFragment ([in] BSTR Tag, [in] BSTR TagFragment)

Parameters

[in] BSTR Tag
[in] BSTR TagFragment

GetTagFragment

Description

Get the specified tag fragment.

Signature

HRESULT GetTagFragment ([in] BSTR Tag, [out, retval] BSTR *pTagFragment)

Parameters

[in] BSTR Tag
[out, retval] BSTR * pTagFragment

GetTagAttributes

Description

Returns the attributes list of the specified tag (if Tag is empty, uses selected)

Signature

HRESULT GetTagAttributes ([in] BSTR Tag, [out, retval] BSTR *pAttributes)

Parameters

[in] BSTR Tag
[out, retval] BSTR * pAttributes

GetTagAttribute

Description

Get a specific attribute from the specified tag (if Tag is empty, uses selected)

Signature

HRESULT GetTagAttribute ([in] BSTR Tag, [in] BSTR Attribute, [out, retval] BSTR *pAttribute)

Parameters

[in] BSTR Tag
[in] BSTR Attribute
[out, retval] BSTR * pAttribute

SetTagAttribute

Description

Sets an attributes on the specified tag (if Tag is empty, uses selected)

Signature

HRESULT SetTagAttribute ([in] BSTR Tag, [in] BSTR Attribute, [in] BSTR Value)

Parameters

[in] BSTR Tag
[in] BSTR Attribute
[in] BSTR Value

SetStyle

Description

Signature

HRESULT SetStyle ([in] BSTR sStyleData, [out, retval] VARIANT_BOOL *pResult)

Parameters

[in] BSTR sStyleData
[out, retval] VARIANT_BOOL * pResult

Details / Examples

Applies a CSS style to the current selection.

  • Style A list of CSS styles definition, for example "font-size : 38pt;color: rgb (0, 100, 0);"

  • FirstLetterStyle The "First Letter " style.

CssStyle

Description

Signature

HRESULT CssStyle ([in] BSTR Style, [in] BSTR FirstLetterStyle, [in] BSTR FirstLineStyle, [out, retval] VARIANT_BOOL *pResult)

Parameters

[in] BSTR Style
[in] BSTR FirstLetterStyle
[in] BSTR FirstLineStyle
[out, retval] VARIANT_BOOL * pResult

CssStyleAtCaret

Description

Get styles at give caret position.

Signature

HRESULT CssStyleAtCaret ([in] BSTR Tag, [out, retval] BSTR *pStyles)

Parameters

[in] BSTR Tag
[out, retval] BSTR * pStyles

Recompose

Description

Signature

HRESULT Recompose ()

Parameters

CursorLeft

Description

Signature

HRESULT CursorLeft ([out, retval] VARIANT_BOOL *pResult)

Parameters

[out, retval] VARIANT_BOOL * pResult

CursorRight

Description

Signature

HRESULT CursorRight ([out, retval] VARIANT_BOOL *pResult)

Parameters

[out, retval] VARIANT_BOOL * pResult

CursorWordLeft

Description

Signature

HRESULT CursorWordLeft ([out, retval] VARIANT_BOOL *pResult)

Parameters

[out, retval] VARIANT_BOOL * pResult

CursorWordRight

Description

Signature

HRESULT CursorWordRight ([out, retval] VARIANT_BOOL *pResult)

Parameters

[out, retval] VARIANT_BOOL * pResult

EnsureVisible

Description

Signature

HRESULT EnsureVisible ()

Parameters

StartSelection

Description

Signature

HRESULT StartSelection ()

Parameters

EndSelection

Description

Signature

HRESULT EndSelection ()

Parameters

MoveCursor

Description

Signature

HRESULT MoveCursor ([in] int Code, [in] xsUnits Unit, [in] int Count, [in] xsMovementType Extend, [out, retval] int *pMoved)

Parameters

[in] int Code
[in] xsUnits Unit
[in] int Count
[in] xsMovementType Extend
[out, retval] int * pMoved

Details / Examples

Moves the selection to the right and returns the number of units it’s been moved.

  • Unit xsUnits. The unit by which the selection is to be moved.

  • Count xsUnits. The number of units the selection is to be moved.

  • Extend Can be either xsMove or xsExtend. If xsMove is used, the selection is collapsed to the end point and moved to the right. If xsExtend is used, the selection is extended to the right. The default value is xsMove.

SelectChar

Description

Selects the character at the current cursor position.

Signature

HRESULT SelectChar ()

Parameters

SelectWord

Description

Selects the word at the current cursor position.

Signature

HRESULT SelectWord ()

Parameters

SelectLine

Description

Selects the line at the current cursor position.

Signature

HRESULT SelectLine ()

Parameters

SelectSentence

Description

Selects the sentence at the current cursor position.

Signature

HRESULT SelectSentence ()

Parameters

SelectParagraph

Description

Selects the paragraph at the current cursor position.

Signature

HRESULT SelectParagraph ()

Parameters

SelectElement

Description

Selects the element at the current cursor position.

Signature

HRESULT SelectElement ()

Parameters

ClearSelection

Description

Clears the current selection.

Signature

HRESULT ClearSelection ()

Parameters

SavePosition

Description

Signature

HRESULT SavePosition ()

Parameters

RestorePosition

Description

Signature

HRESULT RestorePosition ()

Parameters

GetPosition

Description

Signature

HRESULT GetPosition ([out, retval] BSTR *pData)

Parameters

[out, retval] BSTR * pData

GoToPosition

Description

Signature

HRESULT GoToPosition ([in] BSTR sPosition, [out, retval] VARIANT_BOOL *pFound)

Parameters

[in] BSTR sPosition
[out, retval] VARIANT_BOOL * pFound

PositionIsOnParaEnd

Description

Returns true if the current position is on an end of paragraph.

Signature

HRESULT PositionIsOnParaEnd ([out, retval] VARIANT_BOOL *pVal)

Parameters

[out, retval] VARIANT_BOOL * pVal

BeginUndo

Description

Signature

HRESULT BeginUndo ()

Parameters

EndUndo

Description

Ends an undo sequence. The call to EndUndo must be preceeded by a call to BeginUndo.

Signature

HRESULT EndUndo ()

Parameters

GoToDocBegin

Description

Set the position of the cursor at the beginning of the document.

Signature

HRESULT GoToDocBegin ()

Parameters

GoToTagByName

Description

Direction 0 = right, 1 = left.

Signature

HRESULT GoToTagByName ([in] BSTR Tag, [in] int nDirection, [out, retval] VARIANT_BOOL *pMoved)

Parameters

[in] BSTR Tag
[in] int nDirection
[out, retval] VARIANT_BOOL * pMoved

GoToTagByPath

Description

Direction 0 = right, 1 = left, Path is a xPath expression.

Signature

HRESULT GoToTagByPath ([in] BSTR Path, [in] int nDirection, [out, retval] VARIANT_BOOL *pMoved)

Parameters

[in] BSTR Path
[in] int nDirection
[out, retval] VARIANT_BOOL * pMoved

FindString

Description

Find the string optionally matching the case.

Signature

HRESULT FindString ([in] BSTR Text, [in] VARIANT_BOOL bMatchCase, [out, retval] VARIANT_BOOL *pFound)

Parameters

[in] BSTR Text
[in] VARIANT_BOOL bMatchCase
[out, retval] VARIANT_BOOL * pFound

ValidateDom

Description

Validate the dom.

Signature

HRESULT ValidateDom ([out, retval] BSTR *pErrors)

Parameters

[out, retval] BSTR * pErrors

ResampleInlinePictures

Description

Resmaple all pictures not fitting area.

Signature

HRESULT ResampleInlinePictures ([in] VARIANT_BOOL bPromptUser, [out, retval] VARIANT_BOOL *pResult)

Parameters

[in] VARIANT_BOOL bPromptUser
[out, retval] VARIANT_BOOL * pResult

ApplyTagWizard

Description

Signature

HRESULT ApplyTagWizard ([in] BSTR sTagWizard, [out, retval] VARIANT_BOOL *pResult)

Parameters

[in] BSTR sTagWizard
[out, retval] VARIANT_BOOL * pResult

InsertDtxTemplate

Description

Insert a dtx template.

Signature

HRESULT InsertDtxTemplate ([in] BSTR FileName, [in] BSTR TemplateName)

Parameters

[in] BSTR FileName
[in] BSTR TemplateName

InsertOfficeAsset

Description

Signature

HRESULT InsertOfficeAsset ([in] BSTR sOptions, [in] BSTR sData, [out, retval] VARIANT_BOOL *pResult)

Parameters

[in] BSTR sOptions
[in] BSTR sData
[out, retval] VARIANT_BOOL * pResult

GetExternalItemData

Description

Signature

HRESULT GetExternalItemData ([out, retval] BSTR *pData)

Parameters

[out, retval] BSTR * pData

GetInlineItemAtCaret

Description

Returns data relative to the eventual inline item at the current caret position.

Signature

HRESULT GetInlineItemAtCaret ([out, retval] BSTR *pData)

Parameters

[out, retval] BSTR * pData

Properties

Tag

Description

Returns the complete path to the current XML node.

Signature

BSTR Tag

Type

GET SET

Details / Examples

Tags the currently selected text.

  • Tag: name of the tag, for example: signature

TagAtCaret

Description

Returns the tag name the current XML node.

Signature

BSTR TagAtCaret

Type

GET

ChannelAtCaret

Description

Returns the channel attribute at the current caret position.

Signature

BSTR ChannelAtCaret

Type

GET

InheritedAtCaret

Description

Returns true if the text at caret position is inherited.

Signature

VARIANT_BOOL InheritedAtCaret

Type

GET

ModifyableAtCaret

Description

Returns true if the text at caret position is modifyable.

Signature

VARIANT_BOOL ModifyableAtCaret

Type

GET

UpdateCursor

Description

True if cursor movement functions update the display, affects also the display of the current selection.

Signature

VARIANT_BOOL UpdateCursor

Type

GET SET

ViewTags

Description

True if tags are visible.

Signature

VARIANT_BOOL ViewTags

Type

GET SET

Active

Description

Returns the position of the cursor.

Signature

int Active

Type

GET SET

Details / Examples

Set the position of the cursor.

  • Val The cursor position. Use only values previously retrieved with the Active, Start and End properties.

Start

Description

Returns the position of the the first character in the selection.

Signature

int Start

Type

GET SET

End

Description

Returns the position of the the last character in the selection.

Signature

int End

Type

GET SET

CharacterCase

Description

Sets the case of the selected characters.

Signature

xsCharacterCase CharacterCase

Type

SET

Xsmart::IDockablePane API Documentation

Functions

AddPanelButton

Description

Add a button to the toolbar’s pane.

Signature

HRESULT AddPanelButton (int CtrlPosition, long CtrlId, int iImage, BSTR CtrlName, BSTR CtrlDescription, long Cookie)

Parameters

` int CtrlPosition`
` long CtrlId`
` int iImage`
` BSTR CtrlName`
` BSTR CtrlDescription`
` long Cookie`

AddButtonWithImgFile

Description

Signature

HRESULT AddButtonWithImgFile (int CtrlPosition, long CtrlId, BSTR ImgFilePath, BSTR CtrlName, BSTR CtrlDescription, long Cookie)

Parameters

` int CtrlPosition`
` long CtrlId`
` BSTR ImgFilePath`
` BSTR CtrlName`
` BSTR CtrlDescription`
` long Cookie`

Properties

Id

Description

Signature

BSTR Id

Type

GET

Type

Description

Signature

BSTR Type

Type

GET

Document

Description

The document associated to this window.

Signature

IXDocument Document

Type

GET

Selection

Description

Signature

ISelection Selection

Type

GET

Xsmart::IDockablePanes API Documentation

Functions

Properties

Count

Description

Signature

long Count

Type

GET

Item

Description

Signature

IDockablePane Item ([in] long index)

Type

GET

Xsmart::IRestHelper API Documentation

Functions

Get

Description

Signature

HRESULT Get ([in] BSTR url, [in] VARIANT vSuccessCallback, [in] VARIANT vErrorCallback)

Parameters

[in] BSTR url
[in] VARIANT vSuccessCallback
[in] VARIANT vErrorCallback

Post

Description

Signature

HRESULT Post ([in] BSTR url, [in] BSTR postData, [in] VARIANT vSuccessCallback, [in] VARIANT vErrorCallback)

Parameters

[in] BSTR url
[in] BSTR postData
[in] VARIANT vSuccessCallback
[in] VARIANT vErrorCallback

GetRestUrl

Description

Signature

HRESULT GetRestUrl ([out, retval] BSTR *pUrl)

Parameters

[out, retval] BSTR * pUrl

GetRestToken

Description

Signature

HRESULT GetRestToken ([out, retval] BSTR *pToken)

Parameters

[out, retval] BSTR * pToken

GetDtd

Description

Signature

HRESULT GetDtd ([in] BSTR loid, [out, retval] BSTR *pDtd)

Parameters

[in] BSTR loid
[out, retval] BSTR * pDtd

GetTreeDB

Description

Signature

HRESULT GetTreeDB ([in] BSTR dtdPath, [in] BSTR node, [out, retval] BSTR *pTreeDB)

Parameters

[in] BSTR dtdPath
[in] BSTR node
[out, retval] BSTR * pTreeDB

GetTreeDBXml

Description

Signature

HRESULT GetTreeDBXml ([in] BSTR dtdPath, [in] BSTR node, [out, retval] BSTR *pTreeDB)

Parameters

[in] BSTR dtdPath
[in] BSTR node
[out, retval] BSTR * pTreeDB

ParseXMLtoJSON

Description

Signature

HRESULT ParseXMLtoJSON ([in] BSTR url, [out, retval] BSTR *pJson)

Parameters

[in] BSTR url
[out, retval] BSTR * pJson

GetObjectInfo

Description

Signature

HRESULT GetObjectInfo ([in] BSTR loid, [out, retval] BSTR *pObjectInfo)

Parameters

[in] BSTR loid
[out, retval] BSTR * pObjectInfo

Properties

Xsmart::IAppServices API Documentation

Functions

CallService

Description

Signature

HRESULT CallService ([in] BSTR jsonRequest, [out, retval] BSTR *pResult)

Parameters

[in] BSTR jsonRequest
[out, retval] BSTR * pResult

ZipFolder

Description

Signature

HRESULT ZipFolder ([in] BSTR folderPath, [in] BSTR zipFilePath, [in, out] BSTR *errMessage, [out, retval] VARIANT_BOOL *pResult)

Parameters

[in] BSTR folderPath
[in] BSTR zipFilePath
[in, out] BSTR * errMessage
[out, retval] VARIANT_BOOL * pResult

ZipFiles

Description

Signature

HRESULT ZipFiles ([in] BSTR *fileList, [in] BSTR zipFilePath, [in, out] BSTR *errMessage, [out, retval] VARIANT_BOOL *pResult)

Parameters

[in] BSTR * fileList
[in] BSTR zipFilePath
[in, out] BSTR * errMessage
[out, retval] VARIANT_BOOL * pResult

GetApplicationConfigFile

Description

Signature

HRESULT GetApplicationConfigFile ([in] BSTR filePath, [out, retval] BSTR *pResult)

Parameters

[in] BSTR filePath
[out, retval] BSTR * pResult

GetObjectInfoAsJson

Description

Signature

HRESULT GetObjectInfoAsJson ([in] BSTR loid, [out, retval] BSTR *pResult)

Parameters

[in] BSTR loid
[out, retval] BSTR * pResult

GetUserInfoAsJson

Description

Signature

HRESULT GetUserInfoAsJson ([in] BSTR name, [out, retval] BSTR *pResult)

Parameters

[in] BSTR name
[out, retval] BSTR * pResult

Properties