Top Method Summary
Options Name Purpose
+ Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebNode Array (IProparseWebSession, JsonArray) Turns a JsonArray into an array of ProparseWebNode
Inherited from Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebNode
# CHARACTER Array (JsonArray) Turns a JsonArray of characters into an array of characters
Inherited from Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebNode
# LOGICAL CanGetProperty (JsonObject, character) Helper method to check whether a property can be retrieved from a JSON object
Inherited from Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebObject
+ Consultingwerk.Studio.ProparseApi.NodesSet ChildNodes (NodeTypesEnum) Returns the set of child nodes
Inherited from Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebNode
+ LOGICAL Equals (Object) Overrides Equals method to compare NodeNums
Inherited from Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebNode
+ Consultingwerk.Studio.ProparseApi.INode FirstDirectChild (NodeTypesEnum) Find the first direct child with a given node type.
Inherited from Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebNode
# Consultingwerk.Studio.ProparseApi.INode GetNode (character) Helper method to get a node from the backend and create the object
Inherited from Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebObject
# InitArrays () Initializes the extent properties
Inherited from Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebNode
+ InsertTextAfter (longchar) Parses and inserts text after the node
Inherited from Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebNode
# Progress.Lang.Object PostRequest (character, JsonConstruct) Executes a POST request on the server
Inherited from Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebObject
+ Consultingwerk.Studio.ProparseApi.INode Query (NodeTypesEnum) Returns an Array of all node types of the given node type
Inherited from Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebNode
# Progress.Json.ObjectModel.JsonArray RequestJsonArray (character) Helper method to get a JSON array from the server
Inherited from Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebObject
# Progress.Json.ObjectModel.JsonObject RequestJsonObject (character) Helper method to get a JSON object from the server
Inherited from Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebObject
+ CHARACTER ToString () Returns a String representation of the node
Inherited from Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebNode
+ CHARACTER ToStringFulltext () Get the full, preprocessed text from a node
Inherited from Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebNode
+ CHARACTER ToStringSourcetext () Get the full, not preprocessed text from a node
Inherited from Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebNode

Top Constructor Summary
Options Name Purpose
+ ProparseWebBlockNode (IProparseWebSession, JsonObject) Constructor for the ProparseWebBlockNode class

Top Property Summary
Options Name Purpose
+ CHARACTER AllLeadingHiddenText
Inherited from Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebNode
# Progress.Json.ObjectModel.JsonObject BaseJson
Inherited from Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebObject
+ Consultingwerk.Studio.ProparseApi.IBlock Block
+ Consultingwerk.Studio.ProparseApi.ICall Call
Inherited from Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebNode
+ Consultingwerk.Studio.ProparseApi.NodesSet ChildNodes
Inherited from Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebNode
+ INTEGER Column
Inherited from Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebNode
+ CHARACTER Comments
Inherited from Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebNode
# Progress.Json.ObjectModel.JsonObject DetailsJson
Inherited from Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebNode
# Progress.Json.ObjectModel.JsonObject DetailsLinksJson
Inherited from Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebNode
+ Consultingwerk.Studio.ProparseApi.IFieldContainer FieldContainer
Inherited from Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebNode
+ CHARACTER FileName
Inherited from Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebNode
+ CHARACTER FileNames
Inherited from Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebNode
+ Consultingwerk.Studio.ProparseApi.INode FirstChild
Inherited from Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebNode
+ Consultingwerk.Studio.ProparseApi.INode FirstNaturalChild
Inherited from Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebNode
+ Consultingwerk.Studio.ProparseApi.INode LastChild
Inherited from Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebNode
+ Consultingwerk.Studio.ProparseApi.INode LastDescendant
Inherited from Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebNode
+ INTEGER Line
Inherited from Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebNode
# Progress.Json.ObjectModel.JsonObject Links
Inherited from Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebObject
+ LOGICAL Natural
Inherited from Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebNode
+ Consultingwerk.Studio.ProparseApi.INode NextNode
Inherited from Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebNode
+ Consultingwerk.Studio.ProparseApi.INode NextSibling
Inherited from Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebNode
+ INTEGER NodeNum
Inherited from Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebNode
+ Consultingwerk.Studio.ProparseApi.INode Parent
Inherited from Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebNode
+ Consultingwerk.Studio.ProparseApi.INode PrevNode
Inherited from Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebNode
+ Consultingwerk.Studio.ProparseApi.INode PrevSibling
Inherited from Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebNode
# Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.IProparseWebSession Session
Inherited from Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebObject
+ LOGICAL StateHead
Inherited from Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebNode
+ Consultingwerk.Studio.ProparseApi.INode Statement
Inherited from Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebNode
+ Consultingwerk.Studio.ProparseApi.NodeSubTypesEnum SubType
Inherited from Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebNode
+ Consultingwerk.Studio.ProparseApi.ISymbol Symbol
Inherited from Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebNode
+ CHARACTER Text
Inherited from Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebNode
+ Consultingwerk.Studio.ProparseApi.NodeTypesEnum Type
Inherited from Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebNode


Method Detail
Top

PUBLIC Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebNode Array (IProparseWebSession, JsonArray)

Inherited from Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebNode
Purpose: Turns a JsonArray into an array of ProparseWebNode
Notes:

Parameters:
poSession Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.IProparseWebSession
The session for which this array is created
poJsonArray Progress.Json.ObjectModel.JsonArray
The source JsonArray
Returns Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebNode
The resulting ProparseWebNode array
Top

PROTECTED CHARACTER Array (JsonArray)

Inherited from Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebNode
Purpose: Turns a JsonArray of characters into an array of characters
Notes:

Parameters:
poJsonArray Progress.Json.ObjectModel.JsonArray
JsonArray containing characters
Returns CHARACTER
Araay with the characters from poJsonArrays
Top

PROTECTED LOGICAL CanGetProperty (JsonObject, character)

Inherited from Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebObject
Purpose: Helper method to check whether a property can be retrieved from a JSON object
Notes:

Parameters:
poJson Progress.Json.ObjectModel.JsonObject
The Json object to retrieve the property from
pcProperty CHARACTER
Name of the property to retrieve
Returns LOGICAL
TRUE/FALSE whether pcProperty can be retrieved from poJson
Top

PUBLIC Consultingwerk.Studio.ProparseApi.NodesSet ChildNodes (NodeTypesEnum)

Inherited from Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebNode
Purpose: Returns the set of child nodes
Notes:

Parameters:
poNodeType Consultingwerk.Studio.ProparseApi.NodeTypesEnum
The Node Type to find
Returns Consultingwerk.Studio.ProparseApi.NodesSet
The set of child nodes of the given type
Top

PUBLIC LOGICAL Equals (Object)

Inherited from Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebNode
Purpose: Overrides Equals method to compare NodeNums
Notes:

Parameters:
poNode Object
Object to compare with THIS-OBJECT
Returns LOGICAL
True if the given object has the same NodeNum, else false
Top

PUBLIC Consultingwerk.Studio.ProparseApi.INode FirstDirectChild (NodeTypesEnum)

Inherited from Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebNode
Purpose: Find the first direct child with a given node type.
Notes:

Parameters:
poNodeType Consultingwerk.Studio.ProparseApi.NodeTypesEnum
The Node Type to find
Returns Consultingwerk.Studio.ProparseApi.INode
The INode instance
Top

PROTECTED Consultingwerk.Studio.ProparseApi.INode GetNode (character)

Inherited from Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebObject
Purpose: Helper method to get a node from the backend and create the object
Notes:

Parameters:
pcLink CHARACTER
Link to the node resource
Returns Consultingwerk.Studio.ProparseApi.INode
The requested node
Top

PROTECTED InitArrays ()

Inherited from Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebNode
Purpose: Initializes the extent properties
Notes:

Top

PUBLIC InsertTextAfter (longchar)

Inherited from Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebNode
Purpose: Parses and inserts text after the node
Notes: The resulting nodes are added as siblings

Parameters:
plcText LONGCHAR
The text to insert
Top

PROTECTED Progress.Lang.Object PostRequest (character, JsonConstruct)

Inherited from Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebObject
Purpose: Executes a POST request on the server
Notes:

Parameters:
pcUri CHARACTER
URI for the request
poJson Progress.Json.ObjectModel.JsonConstruct
Content for the request
Returns Progress.Lang.Object
The response entity
Top

PUBLIC Consultingwerk.Studio.ProparseApi.INode Query (NodeTypesEnum)

Inherited from Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebNode
Purpose: Returns an Array of all node types of the given node type
Notes:

Parameters:
poNodeType Consultingwerk.Studio.ProparseApi.NodeTypesEnum
The NodeTypeEnum representing the node type
Returns Consultingwerk.Studio.ProparseApi.INode
The array of INode instances
Top

PROTECTED Progress.Json.ObjectModel.JsonArray RequestJsonArray (character)

Inherited from Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebObject
Purpose: Helper method to get a JSON array from the server
Notes:

Parameters:
pcRequestLink CHARACTER
Link to the requested resource
Returns Progress.Json.ObjectModel.JsonArray
JSON array from the response
Top

PROTECTED Progress.Json.ObjectModel.JsonObject RequestJsonObject (character)

Inherited from Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebObject
Purpose: Helper method to get a JSON object from the server
Notes:

Parameters:
pcRequestLink CHARACTER
Link to the requested resource
Returns Progress.Json.ObjectModel.JsonObject
JSON object from the response
Top

PUBLIC CHARACTER ToString ()

Inherited from Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebNode
Purpose: Returns a String representation of the node
Notes:

Returns CHARACTER
String representation of the node
Top

PUBLIC CHARACTER ToStringFulltext ()

Inherited from Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebNode
Purpose: Get the full, preprocessed text from a node
Notes:

Returns CHARACTER
The full, preprocessed text from a node
Top

PUBLIC CHARACTER ToStringSourcetext ()

Inherited from Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebNode
Purpose: Get the full, not preprocessed text from a node
Notes:

Returns CHARACTER
The full, not preprocessed text from a node


Constructor Detail
Top

PUBLIC ProparseWebBlockNode (IProparseWebSession, JsonObject)

Purpose: Constructor for the ProparseWebBlockNode class
Notes:

Parameters:
poSession Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.IProparseWebSession
The session for which this object is being created, also holds HttpClient and JSessionID
poJson Progress.Json.ObjectModel.JsonObject
The JsonObject from which this object is being created


Property Detail
Top

PUBLIC CHARACTER AllLeadingHiddenText

Inherited from Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebNode

Returns CHARACTER
Top

PROTECTED Progress.Json.ObjectModel.JsonObject BaseJson

Inherited from Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebObject

Returns Progress.Json.ObjectModel.JsonObject
Top

PUBLIC Consultingwerk.Studio.ProparseApi.IBlock Block


Returns Consultingwerk.Studio.ProparseApi.IBlock
Top

PUBLIC Consultingwerk.Studio.ProparseApi.ICall Call

Inherited from Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebNode

Returns Consultingwerk.Studio.ProparseApi.ICall
Top

PUBLIC Consultingwerk.Studio.ProparseApi.NodesSet ChildNodes

Inherited from Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebNode

Returns Consultingwerk.Studio.ProparseApi.NodesSet
Top

PUBLIC INTEGER Column

Inherited from Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebNode

Returns INTEGER
Top

PUBLIC CHARACTER Comments

Inherited from Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebNode

Returns CHARACTER
Top

PROTECTED Progress.Json.ObjectModel.JsonObject DetailsJson

Inherited from Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebNode

Returns Progress.Json.ObjectModel.JsonObject
Top

PROTECTED Progress.Json.ObjectModel.JsonObject DetailsLinksJson

Inherited from Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebNode

Returns Progress.Json.ObjectModel.JsonObject
Top

PUBLIC Consultingwerk.Studio.ProparseApi.IFieldContainer FieldContainer

Inherited from Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebNode

Returns Consultingwerk.Studio.ProparseApi.IFieldContainer
Top

PUBLIC CHARACTER FileName

Inherited from Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebNode

Returns CHARACTER
Top

PUBLIC CHARACTER FileNames

Inherited from Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebNode

Returns CHARACTER
Top

PUBLIC Consultingwerk.Studio.ProparseApi.INode FirstChild

Inherited from Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebNode

Returns Consultingwerk.Studio.ProparseApi.INode
Top

PUBLIC Consultingwerk.Studio.ProparseApi.INode FirstNaturalChild

Inherited from Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebNode

Returns Consultingwerk.Studio.ProparseApi.INode
Top

PUBLIC Consultingwerk.Studio.ProparseApi.INode LastChild

Inherited from Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebNode

Returns Consultingwerk.Studio.ProparseApi.INode
Top

PUBLIC Consultingwerk.Studio.ProparseApi.INode LastDescendant

Inherited from Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebNode

Returns Consultingwerk.Studio.ProparseApi.INode
Top

PUBLIC INTEGER Line

Inherited from Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebNode

Returns INTEGER
Top

PROTECTED Progress.Json.ObjectModel.JsonObject Links

Inherited from Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebObject

Returns Progress.Json.ObjectModel.JsonObject
Top

PUBLIC LOGICAL Natural

Inherited from Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebNode

Returns LOGICAL
Top

PUBLIC Consultingwerk.Studio.ProparseApi.INode NextNode

Inherited from Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebNode

Returns Consultingwerk.Studio.ProparseApi.INode
Top

PUBLIC Consultingwerk.Studio.ProparseApi.INode NextSibling

Inherited from Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebNode

Returns Consultingwerk.Studio.ProparseApi.INode
Top

PUBLIC INTEGER NodeNum

Inherited from Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebNode

Returns INTEGER
Top

PUBLIC Consultingwerk.Studio.ProparseApi.INode Parent

Inherited from Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebNode

Returns Consultingwerk.Studio.ProparseApi.INode
Top

PUBLIC Consultingwerk.Studio.ProparseApi.INode PrevNode

Inherited from Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebNode

Returns Consultingwerk.Studio.ProparseApi.INode
Top

PUBLIC Consultingwerk.Studio.ProparseApi.INode PrevSibling

Inherited from Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebNode

Returns Consultingwerk.Studio.ProparseApi.INode
Top

PROTECTED Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.IProparseWebSession Session

Inherited from Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebObject

Returns Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.IProparseWebSession
Top

PUBLIC LOGICAL StateHead

Inherited from Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebNode

Returns LOGICAL
Top

PUBLIC Consultingwerk.Studio.ProparseApi.INode Statement

Inherited from Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebNode

Returns Consultingwerk.Studio.ProparseApi.INode
Top

PUBLIC Consultingwerk.Studio.ProparseApi.NodeSubTypesEnum SubType

Inherited from Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebNode

Returns Consultingwerk.Studio.ProparseApi.NodeSubTypesEnum
Top

PUBLIC Consultingwerk.Studio.ProparseApi.ISymbol Symbol

Inherited from Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebNode

Returns Consultingwerk.Studio.ProparseApi.ISymbol
Top

PUBLIC CHARACTER Text

Inherited from Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebNode

Returns CHARACTER
Top

PUBLIC Consultingwerk.Studio.ProparseApi.NodeTypesEnum Type

Inherited from Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebNode

Returns Consultingwerk.Studio.ProparseApi.NodeTypesEnum


©2006-2023 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       15.04.2024 06:16:02