Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migration of unmigrated content due to installation of a new plugin

...

Description

Excerpt

Sets an int representing the line spacing for a paragraph.

Signature
C#
C#
 public void SetLineSpacing(int spacing, SpacingRule type)
{signature}{signature:
}
Signature
vb.net
vb.net
Public Sub SetLineSpacing(ByVal spacing As Integer, ByVal type As SpacingRule)
{signature}
{parameters}
{param:spacing}The value for the spacing. The units depend on the type parameter.{param}
{param:type}The type of spacing to use. See [SpacingRule|ParagraphFormatting.SpacingRule] for a discussion on the different types of spacing.{param}
{remarks}There are three types of line spacing: AtLeast, Exactly, and Multiple. AtLeast and Exactly are set in twips.  One twip = \(1/20 pt\) or \(1/1440 in\). Multiple is set in number of lines. AtLeast must be between 0 pt \(0 twips\) and 1584 pt \(31680 twips\).  Exactly must be between 0.7 pt \(14 twips\) and 1584 pt \(31680 twips\). Multiple must be between 1 line and 132 lines. Values beyond these for all 3 types will be adjusted automatically.

MS Word equivalent: Format menu > Paragraph... > Indents and Spacing > Spacing section > At:

{remarks}
{example}{code:csharp|title=C#}
Parameters
Param
spacing
spacing

The value for the spacing. The units depend on the type parameter.

Param
type
type

The type of spacing to use. See SpacingRule for a discussion on the different types of spacing.

Remarks

There are three types of line spacing: AtLeast, Exactly, and Multiple. AtLeast and Exactly are set in twips. One twip = (1/20 pt) or (1/1440 in). Multiple is set in number of lines. AtLeast must be between 0 pt (0 twips) and 1584 pt (31680 twips). Exactly must be between 0.7 pt (14 twips) and 1584 pt (31680 twips). Multiple must be between 1 line and 132 lines. Values beyond these for all 3 types will be adjusted automatically.

MS Word equivalent: Format menu > Paragraph... > Indents and Spacing > Spacing section > At:

Example
Code Block
csharp
csharp
titleC#


          //--- Set LineSpacing to 2 lines
          oParagraphFormatting.SetLineSpacing(2,
               ParagraphFormatting.SpacingRule.Multiple);
        
{code} {code:
Code Block
vb.net
|title=
vb.net
titlevb.net
}


          '--- Set LineSpacing to 2 lines
          oParagraphFormatting.SetLineSpacing(2, _
               ParagraphFormatting.SpacingRule.Multiple)
        
{code} {example}