IsChecked Property

Build 1501 on 14/Nov/2017  This topic last edited on: 22/Mar/2016, at 17:08

Description

Returns true if the text is checked-out by you - i.e. it can be modified.

Available in Ted and in Fred.

Note: if the text is checked-out by someone else, it won't return True. Use instead this syntax - if the returned string is not empty, it contains the name of the user who's editing the element:

Dim uname As String = UtilsBase.GetObjCurEditorName(elementId, FalseTrue)

Syntax

object.IsChecked

object

Required. Object name. Returned by Ted.GetActiveTxt, objNode.GetTxt or objArticle.GetTxt(nIdx).

Example

This script displays the check status of the text.

If Ted.HasActiveTxt Then

 dim objT = Ted.GetActiveTxt

 dim bStat = objT.IsChecked

 msgbox (bStat)         ' displays FALSE if texts was not checked out

End If

Context

Text object

See also

IsChanged, IsNew, IsLinked

GetObjCurEditorName Script