Engine Help Category: RichText
Filtered overview of the Engine Help documentation.
@GetDataType
Returns the data type of the variable VAR1. Data type: Return value: TEXT A TEXTLIST AL NUMBER N NUMBERLIST NL FLOAT F FLOATLIST FL TD T TDLIST TL RT (RICHTEXT) RT ID I IDLIST IL UNIDLIST …
@GetPictureFileInfo
Returns information about the contents of an image file (an image within an image file). FILEHANDLE PICFILEHANDLE: FILEHANDLE to an image file opened in binary mode. FN FILETYPE: 1=TIFF File monochrom (T4 Compression in …
@GetVar
Returns the value of the variable named TEXT NAME1 . If the variable belongs to a group (e.g. a document), the group name (e.g. the NOTEHANDLE of the document) as TEXT GROUP2 must be specified. This enables an alternativ …
@GetVarWithFieldFlags
Returns the value of the variable named TEXT NAME1 . If the variable belongs to a group (e.g. a document), the group name (e.g. the NOTEHANDLE of the document) as TEXT GROUP2 must be specified. This enables an alternativ …
@GetVStackPath2GFun
Returns the prefix for the access path of a variable stored within the thread copy of a global function. This could be used, for example, to assign default values for local parameters. However, this function should be av …
@LogReport
Outputs the contents of the variable VAR1 to the API log and on the server console. With FN OPTIONS2 the detailed behavior of the @Function can be defined. FNLIST STYLE3 specifies the font, options, color and size of the …
@Name
Basically analogous to Notes. Difference: The KEYWORD must be enclosed in quotation marks: Therefore, instead of [CN] "[CN]" must be specified etc. KEYWORD: [O] [C] [OU1] [OU2] [OU3] [OU4] [CN] [Canonicalize] [Abbreviate …
@RTAddButton
Appends a button labeled TEXT TEXT1 and containing the CNFORMULA CNFORMULA4 to the RichText field RT RT5. FNLIST STYLE2: 1. StyleDefinitionNumber 2. Font 3. Size 4. options 5. Color 1. StyleDefinitionNumber: Re …
@RTAddDocLink
Inserts a document link (DocLink) into the RichText field RT RTFIELD4. The link points to the document identified by NOTEHANDLE NOTEHANDLE3 in the database identified by DBHANDLE DBHANDLE1 and from the view identified by …
@RTAddFileIcon
Appends a file icon in OS/2 style to the RichText field RT RT4. TEXT1: Name of the file attachment used for display and for reference within the Notes document. This name must be unique. TEXT2: Original name of the file …
@RTAddHotSpotTextDocLink
Adds a document link (DocLink) to the document in the database with DBHANDLE DBHANDLE1 from the view with VIEWHANDLE VIEWHANDLE2 and the NOTEHANDLE NOTEHANDLE3 in the rich-text field RT RTFIELD4 a. The parameter DOCLINKL …
@RTAddParagraph
Appends the RICHTEXT paragraph RT1, which is a complete RICHTEXT-portion, to the HRT (HUGERICHTEXT) variable HRT2. A RICHTEXT field consists of many individual paragraphs that describe the elements of the RICHTEXT field, …
@RTAddPictureFile
This function added to the HRT field HRT3 the content the image file with FH (FILEHANDLE) PICFILEHANDLE1. With Parameter FN FILETYPE2 the type of the image file must be specified. Return value: On success, the modified H …
@RTAddPopUpEnd
Adds a logical closing pop-up bracket to the RichText field RT3. See @RtAddPopUpStart.
@RTAddPopUpStart
Appends TEXT TEXT1 or CNFORMULA CNFORMULA1 as a pop-up with the pop-up flags FN FLAGS2 to the end of the RichText value RT RT3. This should be regarded as a logical opening bracket. Everything appended to the RichText fi …
@RTAddText
Appends the TEXT TEXT1 in the font/style NUMBERLIST STYLE2 to the end of the Richtext RT RT3. FN STYLE2: 1. StyleDefinitionNumber 2. Font 3. Size 4. options 5. Color 1. StyleDefinitionNumber: Reserved 2. Font: …
@RTAttachmentIconChange
The variable RT RT1 is searched for file icons that refer to the file attachments specified in TEXT/TEXTLIST TEXT1/TEXTLIST1. Any file icons found are renamed to the names specified in TEXT/TEXTLIST TEXT2/TEXTLIST2, corr …
@RTDocFontsAddFont
Adds a new font with the name TEXT TEXT2 and the optional font family FN FNFONTFAMILY3 to a font field HRT HRT1, whose name is usually $Fonts. Return value: A FontHandle (NUMBER) for the new font, or @ERROR in case of an …
@RTDocFontsGet
Returns the available fonts from the font field HRT HRT1, whose name is usually $Fonts. RETTEXTLIST2 returns a TEXTLIST containing the names of the fonts included. RETNUMBERLIST3 returns a NUMBERLIST containing the corre …
@RTFetchInit
Initializes paragraph-by-paragraph retrieval of the RICHTEXT variable HRT HRT1. Return value: On success, a fetch handle for the HRT field HRT1 is returned; otherwise @ERROR is returned. This fetch handle must be passed …
@RTFetchParagraph
On each call, returns one paragraph of the RICHTEXT field HRT HRT1 in RT REGRTPARAGRAPH. This paragraph is returned as plain RT, not as HUGERICHTEXT. The fetch handle RTFH must initially have been initialized by @RTFetch …
@RTFetchText
Returns the text portion of HRT HRT1 as TEXT, portion by portion. At the beginning, NUMBER RETNUMBER2 must contain 0. NUMBER RETNUMBER2 specifies the SEGMENTPOINTER. If there is more text to retrieve, @RTFetchText return …
@RTInit
This function initializes an empty RichText value. FLOATLIST MARGINLIST1 can be used to set margins, and FLOATLIST TABLIST2 can be used to set tab stops for this field. MARGINLIST1: 1. Left margin in cm 2. Right margin i …
@RTInitEmpty
This function initializes an absolutely empty RichText value (0 bytes). IMPORTANT: The field flags; see @SetFieldFlags, of the return variable are set to 0. This is necessary because RichText fields should not have the S …
@RTSigTranslate
Returns, for a RICHTEXT paragraph signal (a type of identifier for a portion of RICHTEXT) a more meaningful TEXT value. In parameter FN FNMODE the type of the RICHTEXT field must be specified. By default, normal RICHTEXT …
Operator :=
In principle, analogous to Notes. Difference: Assignment (:=) is an operator and can therefore be used in chains. IMPORTANT: Field flags are not affected by assignments.