AppOutputLine

www.altova.com Print this Topic Previous Page Up One Level Next page

Home >  The MapForce API > Object Reference > Interfaces >

AppOutputLine

Represents a message line. In contrast to ErrorMarker, its structure is more detailed and can contain a collection of child lines, therefore forming a tree of message lines.

 

Properties to navigate the object model:

 

Application
Parent

 

Line access:

 

GetLineSeverity
GetLineSymbol
GetLineText
GetLineTextEx
GetLineTextWithChildren
GetLineTextWithChildrenEx

 

A single AppOutputLine consists of one or more sub-lines. Sub-line access:

 

GetLineCount

 

A sub-line consists of one or more cells. Cell access:

 

GetCellCountInLine
GetCellIcon
GetCellSymbol
GetCellText
GetCellTextDecoration
GetIsCellText

 

Below an AppOutputLine there can be zero, one, or more child lines which themselves are of type AppOutputLine, which thus form a tree structure.

 

Child lines access:

 

ChildLines

 

Properties

Name

Description

Application

Read-only.

Retrieves the application's top-level object.

ChildLines

Read-only.

Returns a collection of the current line's direct child lines.

Parent

Read-only.

The parent object according to the object model.

 

Methods

Name

Description

GetCellCountInLine

Gets the number of cells in the sub-line indicated by nLine in the current AppOutputLine.

GetCellIcon

Gets the icon of the cell indicated by nCell in the current AppOutputLine's sub-line indicated by nLine

GetCellSymbol

Gets the symbol of the cell indicated by nCell in the current AppOutputLine's sub-line indicated by nLine

GetCellText

Gets the text of the cell indicated by nCell in the current AppOutputLine's sub-line indicated by nLine

GetCellTextDecoration

Gets the decoration of the text cell indicated by nCell in the current AppOutputLine's sub-line indicated by nLine. It can be one of the ENUMAppOutputLine_TextDecoration values.

GetIsCellText

Returns true if the cell indicated by nCell in the current AppOutputLine's sub-line indicated by nLine is a text cell.

GetLineCount

Gets the number of sub-lines the current line consists of.

GetLineSeverity

Gets the severity of the line. It can be one of the ENUMAppOutputLine_Severity values.

GetLineSymbol

Gets the symbol assigned to the whole line.

GetLineText

Gets the contents of the line as text.

GetLineTextEx

Gets the contents of the line as text using the specified part and line separators.

GetLineTextWithChildren

Gets the contents of the line including all child and descendant lines as text.

GetLineTextWithChildrenEx

Gets the contents of the line including all child and descendant lines as text using the specified part, line, tab and item separators.


© 2019 Altova GmbH