WrdParagraphFormat.Rd
WrdParagraphFormat
can be used to get and set the font in Word for the text to be inserted.
WrdParagraphFormat(wrd = DescToolsOptions("lastWord"))
WrdParagraphFormat(wrd) <- value
a list defining the paragraph format.
This can contain any combination of:
LeftIndent
, RightIndent
, SpaceBefore
, SpaceBeforeAuto
, SpaceAfter
, SpaceAfterAuto
,
LineSpacingRule
, Alignment
, WidowControl
, KeepWithNext
, KeepTogether
, PageBreakBefore
,
NoLineNumber
, Hyphenation
, FirstLineIndent
, OutlineLevel
, CharacterUnitLeftIndent
,
CharacterUnitRightIndent
, CharacterUnitFirstLineIndent
, LineUnitBefore
, LineUnitAfter
and/or MirrorIndents
.
The possible values of the arguments are found in the Word constants with the respective name.
The alignment for example can be set to wdAlignParagraphLeft
, wdAlignParagraphRight
, wdAlignParagraphCenter
and so on.
Left alignment with indentation would be set as:list(Alignment=wdConst$wdAlignParagraphLeft, LeftIndent=42.55)
.
the pointer to a word instance. Can be a new one, created by GetNewWrd()
or an existing one, created by GetCurrWrd()
.
Default is the last created pointer stored in DescToolsOptions("lastWord")
.
an object with the class paragraph
, basically a list with the attributes of the paragraph in the current cursor position:
left indentation in (in points) for the specified paragraphs.
right indent (in points) for the specified paragraphs.
spacing (in points) before the specified paragraphs.
TRUE
if Microsoft Word automatically sets the amount of spacing before the specified paragraphs.
amount of spacing (in points) after the specified paragraph or text column.
TRUE
if Microsoft Word automatically sets the amount of spacing after the specified paragraphs.
line spacing for the specified paragraph formatting. Use wdLineSpaceSingle
, wdLineSpace1pt5
, or wdLineSpaceDouble
to set the line spacing to one of these values. To set the line spacing to an exact number of points or to a multiple number of lines, you must also set the LineSpacing
property.
WdParagraphAlignment
constant that represents the alignment for the specified paragraphs.
TRUE
if the first and last lines in the specified paragraph remain on the same page as the rest of the paragraph when Word repaginates the document. Can be TRUE
, FALSE
or wdUndefined
.
TRUE
if the specified paragraph remains on the same page as the paragraph that follows it when Microsoft Word repaginates the document. Read/write Long.
TRUE
if all lines in the specified paragraphs remain on the same page when Microsoft Word repaginates the document.
TRUE
if a page break is forced before the specified paragraphs. Can be TRUE
, FALSE
, or wdUndefined
.
TRUE
if line numbers are repressed for the specified paragraphs. Can be TRUE
, FALSE
, or wdUndefined
.
TRUE
if the specified paragraphs are included in automatic hyphenation. FALSE
if the specified paragraphs are to be excluded from automatic hyphenation.
value (in points) for a first line or hanging indent. Use a positive value to set a first-line indent, and use a negative value to set a hanging indent.
outline level for the specified paragraphs.
left indent value (in characters) for the specified paragraphs.
right indent value (in characters) for the specified paragraphs.
amount of spacing (in gridlines) before the specified paragraphs.
amount of spacing (in gridlines) after the specified paragraphs.
Long that represents whether left and right indents are the same width. Can be TRUE
, FALSE
, or wdUndefined
.
if (FALSE) { # \dontrun{
# Windows-specific example
wrd <- GetNewWrd() # get the handle to a new word instance
WrdParagraphFormat(wrd=wrd) <- list(Alignment=wdConst$wdAlignParagraphLeft,
LeftIndent=42.55)
ToWrd("Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua.
At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd
gubergren, no sea takimata sanctus est.\n", wrd=wrd)
# reset
WrdParagraphFormat(wrd=wrd) <- list(LeftIndent=0)
} # }