right-indentation

Arguments: text-edit-pane

Returns the current indentation of the righthand side of a paragraph of text in a text-edit-pane, or the indentation indicated by the corresponding righthand slider of a rich-edit-ruler. In either case, the value is measured in points leftward from the rightmost position. When the text-edit-pane or rich-edit-ruler is resized, the right-indentation value will remain the same and the text (and/or slider) will remain indented by the same relative amount from the righthand side. (In releases prior to 6.1, this value was measured from the lefthand side, and so did not follow window resizing.)

The method for text-edit-pane returns the righthand indentation for the paragraph that contains the text cursor, or the first paragraph that is partly or wholly contained in the selected text, if any.

The setf method for text-edit-pane sets the righthand indentation of the body of the paragraph that contains the text cursor (or all paragraphs that are partly or wholly selected, if any). If there is a rich-edit-ruler associated with the text-edit-pane (see the function ruler), then the rich-edit-ruler's indentation will be automatically modified to match.

The method for rich-edit-ruler returns the position of the righthand slider.

The setf method for rich-edit-ruler moves the righthand slider of the ruler to the specified position. The slider will be constrained at position 0 (the rightmost position) if an attempt is made to move it to a negative position. If there is a text-edit-pane associated with the ruler (see the function rich-edit), then the paragraph in the text-edit-pane that contains the text cursor (or all paragraphs that are partly or wholly contained in the selected text, if any) will be automatically modified to match.

To read or modify multiple paragraph attributes of a text-edit-pane at once, see get-paragraph-format or set-paragraph-format. See also body-left-indentation and top-left-indentation.

See cg-rich-text.htm for information about rich text editing in Common Graphics.

Copyright (c) 1998-2016, Franz Inc. Oakland, CA., USA. All rights reserved.
This page was not revised from the 8.1 page.
Created 2010.1.21.