Xbasic

RTF

Description

RTF Methods and Properties in Alpha Anywhere.

Name
Description
RTFMEMO

RTFMEMO Methods and Properties in Alpha Anywhere.

RTF.BINARY_TEXT Function

The .BINARY_TEXT property returns the binary value of the RTF text.

RTF.PLAIN_TEXT Function

The .PLAIN_TEXT property returns the unformatted text value of the RTF text.

RTF.RTF_TEXT Function

The .RTF_TEXT property returns the text and RTF encoding of the RTF object.

RTF.STYLE Function

The RTF Memo Editor supports up to 8 different styles.

RTF Properties

Properties

Object NameCharacter

The name of the control. Setup Property

Example

:formname.controlname.object.name as C
Enable during viewLogical

Determines whether the user can read the RTF text in the pop-up editor. Setup Property

Example

:formname.controlname.object.enabled as L
Show scroll bars

Determines whether scroll bars will appear when the pop-up editor appears. Setup Property

Allow growth when printingLogical

Determines whether the control can be expanded when printing. Setup Property

Example

:formname.controlname.object.growable as L
Allow shrink when printingLogical

Determines whether the control can be reduced when printing. Setup Property

Example

:formname.controlname.object.shrinkable as L
HideLogical

Determines whether the control is visible. Setup Property

Example

:formname.controlname.object.visible as L
Always on topLogical

Determines whether the control will always be placed on top of other objects in the same location. Setup Property

Example

:formname.controlname.object.always_on_top as L
Border StyleCharacter

Sets the border line style. Border Property

Example

:formname.controlname.border.style as C
Border ColorCharacter

Sets the border line color (using a color name or RGB value ). Border Property

Example

:formname.controlname.border.color as C
Border WidthNumeric

The width of the border line in pixels. Border Property

Example

:formname.controlname.border.width as N
Show Left, Right, Top, BottomLogical

For edge shape "Square" determines which sides of the rectangle will display. For other edge shapes, determines which corners will be square or styled. Border Property

Example

:formname.controlname.border.has_bottom_edge as L
:formname.controlname.border.has_left_edge as L
:formname.controlname.border.has_right_edge as L
:formname.controlname.border.has_top_edge as L
Shadow StyleCharacter

Determines how much the shadow will be offset and its degree of shading. Border Property

Example

:formname.controlname.shadow.style as C
Shadow ColorCharacter

Sets the shadow color (using a color name or RGB value ). Border Property

Example

:formname.controlname.shadow.color as C
Background StyleCharacter

The fill color mode and translucency of the control's background. Border Property

Example

:formname.controlname.Background_style as C
FillCharacter

The style and color(s) of the control's background. Border Property

Example

:formname.controlname.fill.backcolor as C
:formname.controlname.fill.forecolor as C
:formname.controlname.fill.style as C
LeftNumeric

Sets the horizontal position of the control. Dimension Property

Example

:formname.controlname.object.left as N
TopNumeric

Sets the vertical position of the control. Dimension Property

Example

:formname.controlname.object.top as N
WidthNumeric

Sets the width of the control. Dimension Property

Example

:formname.controlname.object.width as N
HeightNumeric

Sets the height of the control. Dimension Property

Example

:formname.controlname.object.height as N
AnchorNumeric

Determines the way the tabbed control will or will not stretch as the base form is resized. Possible attachment points are: 1 = top and right, 2 = top, left, and right, 4 = bottom and left, 5 = bottom and right, 6 = bottom, left, and right, 8 = top, bottom, and left, 9 = top, bottom, and right, 10 = top, bottom, left, and right. Dimension Property

Example

:formname.controlname.object.anchor as N

Methods

RTF.CENTER_JUSTIFY Method

The .CENTER_JUSTIFY() method center justifies RTF text.

RTF.CLASS Method

The .CLASS() method returns the class of the object referenced by

RTF.COPY Method

The .COPY() method copies the currently selected text and puts it on the clipboard.

RTF.CREATE Method

The RTF.CREATE() method creates a new RTF object and returns a pointer to it.

RTF.CUT Method

The .CUT() method cuts the currently selected text and puts it on the clipboard.

RTF.DELETE Method

The .DELETE() method deletes selected text from an RTF object.

RTF.FULL_JUSTIFY Method

The .FULL_JUSTIFY() method full justifies all lines but the last line of a paragraph of RTF text.

RTF.GET_CURSOR Method

The .GET_CURSOR() method returns the location of the cursor in the RTF text.

RTF.GET_FONT Method

The .GET_FONT() method returns the font of the selected text.

RTF.GET_FONT_COLOR Method

The .GET_FONT_COLOR() method returns the font color of the selected text.

RTF.GET_JUSTIFICATION Method

The .GET_JUSTIFICATION() method returns the justification of the RTF text.

RTF.INSERT_ELSE Method

The .INSERT_ELSE() method inserts an ELSE operator at the cursor location.

RTF.INSERT_ELSEIF Method

The .INSERT_ELSEIF() method inserts an ELSEIF operator at the cursor location.

RTF.INSERT_ENDIF Method

The .INSERT_ENDIF() method inserts an ENDIF operator at the cursor location.

RTF.INSERT_IF Method

The .INSERT_IF() method inserts paired IF and ENDIF operators at the cursor location.

RTF.INSERT_IF_UNPAIRED Method

The .INSERT_IF_UNPAIRED() method inserts an IF operator at the cursor location.

RTF.INSERT_IFELSE Method

The .INSERT_ELSEIF() method inserts an IFELSE operator at the cursor location.

RTF.INSERT_IFELSE_UNPAIRED Method

The .INSERT_ELSEIF_UNPAIRED() method inserts an IFELSE operator at the cursor location.

RTF.INSERT_PAGEBREAK Method

The .INSERT_PAGEBREAK() method inserts a page break at the cursor location.

RTF.INSERT_TEXT Method

The .INSERT_TEXT() method inserts New_Text at the cursor location.

RTF.IS_VALID Method

The .IS_VALID() method returns True if the RTF Editor is open; otherwise, it returns False.

RTF.LEFT_JUSTIFY Method

The .LEFT_JUSTIFY() method left justifies RTF text.

RTF.PASTE Method

The .PASTE() method pastes from the clipboard into the RTF object at the cursor location.

RTF.PROPERTIES Method

The .PROPERTIES() method displays the Properties dialog for the RTF text.

RTF.REPAINT Method

The .REPAINT() method redisplays the contents of the RTF memo control by forcing a repaint of the control or window.

RTF.REPLACE_TEXT Method

The .REPLACE_TEXT() method replaces the currently selected text with New_Text.

RTF.RESET Method

The .RESET() method clears the contents of the RTF memo control.

RTF.RIGHT_JUSTIFY Method

The .RIGHT_JUSTIFY() method right justifies RTF text.

RTF.SELECT Method

The .SELECT() method selects text starting at Start_Position for Length characters.

RTF.SET_CURSOR Method

The .SET_CURSOR() method places the cursor at the specified Location.

RTF.SET_FONT Method

The .SET_FONT() method sets the font name and color for the next insertion into the RTF object.

RTF.SET_STYLE Method

The .SET_STYLE() method applies the selected style to the paragraph at the cursor location.

RTF.SHOW_CARET Method

The .SHOW_CARET() method displays the cursor in the RTF text.

RTF.SHOW_CODES Method

The .SHOW_CODES() method toggles the display of formatting codes on and off.

RTFTEXT.INSERT Method

The .INSERT() method inserts text into a plain text RTF object. If Position is 0, the text is inserted at the end.

See Also