Show / Hide Table of Contents
  • BC HTML Api reference
    • html-api
      • AnnotationArrowOrientation
      • AnnotationTextAlignment
      • AnnotationTextFontFamily
      • BarcodeOrientation
      • BarcodeThresholdMode
      • BarcodeType
      • BatchEnums
        • Mode
        • Queue
      • CallContext
      • DbClient
      • DbServer
      • FileMimeType
      • FileType
      • IAnnotation
      • IAnnotationProperties
      • IApplication
      • IBarcodeData
      • IBaseControl
      • IBatch
      • IBatchClass
      • IButton
      • ICheckBox
      • IComboBox
      • ICustomThemeConfig
      • IDocument
      • IDocumentClass
      • IField
      • IFieldValidation
      • IFileInfo
      • IFolder
      • IFolderClass
      • IFormType
      • IGroup
      • IIndexClass
      • IITModule
      • IJob
      • ILabel
      • ILicenseGroup
      • IListItem
      • IListView
      • ImageColorMode
      • ImageOperationType
      • INode
      • INodeComment
      • INodeReviewComment
      • INuanceEngineConfig
      • IOCRConfiguration
      • IPage
        • Side
      • IRadioButton
      • IRecognitionProfile
      • IRectangle
      • IRegexValidation
      • IScanProfile
      • ITable
      • ITabView
      • ITextBox
      • IthConfig
      • ITitledPanel
      • IUser
      • LevelName
      • NodeReviewStatus
      • NuanceEngine
      • NuanceLanguage
      • NuanceMode
      • PageSideMode
      • RecognitionEngine
      • RpcService
      • ScanService
      • ScanSource
      • ScriptActionType
      • ScriptResultConsts
      • ScriptResultProp
      • UnloadReason

Interface INodeComment

Represents a comment that is added on a INode. Each comment has a subject and a body (content).

Properties list

content subject user userInfo

Methods list

getContent() getSubject() getUser() getUserInfo()

Properties

content

see INodeComment.getContent()

Declaration
readonly content: string;
Property Value
Type Description
string

subject

see INodeComment.getSubject()

Declaration
readonly subject: string;
Property Value
Type Description
string

user

see INodeComment.getUser()

Declaration
readonly user: IUser;
Property Value
Type Description
IUser

userInfo

see INodeComment.getUserInfo()

Declaration
readonly userInfo: string;
Property Value
Type Description
string

Methods

getContent()

Returns the contents of this comment.

Declaration
getContent(): string;
Returns
Type Description
string

getSubject()

Returns the subject of this comment.

Declaration
getSubject(): string;
Returns
Type Description
string

getUser()

Returns the IUser who created this comment. If the comment was created by an external user, then this function will return null. In that case, you may use method INodeComment.getUserInfo() to get a String that represents the external user.

Declaration
getUser(): IUser;
Returns
Type Description
IUser

getUserInfo()

Returns a String that represents an external user who created this comment.

Declaration
getUserInfo(): string;
Returns
Type Description
string
Back to top Generated by DocFX