BorderStyle Enumeration

Specifies line style for a border.

Namespace: GemBox.Document
Assembly: GemBox.Document (in GemBox.Document.dll) Version: 31.0.35.1215

Syntax

public enum BorderStyle

Public Enumeration BorderStyle

Members

Member name	Value	Description
None	0	No border.
Single	1	Single line border.
Double	2	Double line border.
Triple	3	Triple line border.
Dotted	4	Dotted line border.
Dashed	5	Dashed line border.
DotDash	6	Dot - dash line border.
DotDotDash	7	Dot - dot - dash line border.
Wave	8	Wave line border.
DoubleWave	9	Double wave line border.
Outset	10	Outset set of line borders.
Inset	11	Inset set of line borders.
DashSmallGap	12	Dash with small gap line borders.
ThickThinLargeGap	13	Thick - thin with large gap line borders.
ThickThinMediumGap	14	Thick - thin with medium gap line borders.
ThickThinSmallGap	15	Thick - thin with small gap line borders.
ThinThickLargeGap	16	Thin - thick with large gap line borders.
ThinThickMediumGap	17	Thin - thick with medium gap line borders.
ThinThickSmallGap	18	Thin - thick with small gap line borders.
ThinThickThinLargeGap	19	Thin - thick - thin with large gap line borders.
ThinThickThinMediumGap	20	Thin - thick - thin with medium gap line borders.
ThinThickThinSmallGap	21	Thin - thick - thin with small gap line borders.
DashDotStroked	22	Dash - dot stroked line border.
Emboss3D	23	3D embossed line border.
Engrave3D	24	3D engraved line border.

Remarks

BorderStyle is specified when creating a new SingleBorder and assigning it to a CharacterFormat.Border property, or when setting a multiple borders through SetBorders(MultipleBorderTypes, BorderStyle, Color, Double) on ParagraphFormat.Borders, TableFormat.Borders or TableCellFormat.Borders properties.

Supported values in PDF, XPS and image file formats:

Single
Double
Dotted
Dashed
DashSmallGap
DotDash
DotDotDash

Examples

Following example shows how to create a document that demonstrates all available border styles.

Copy

// Get all border styles.
var borderStyles = (BorderStyle[])Enum.GetValues(typeof(BorderStyle));

// Create a new empty document.
var doc = new DocumentModel();

// Insert a table with 1 column and 'borderStyles.Length' rows.
doc.Sections.Add(
    new Section(doc, 
        new Table(doc, borderStyles.Length, 1, (row, column) =>
        {
            // Create a new table cell with text taken from 'borderStyles' array at index 'row'.
            var cell = new TableCell(doc, new Paragraph(doc, borderStyles[row].ToString()));

            // Set cell outside borders to red color, with width of 2 points and with border style taken from 'borderStyles' array at index 'row'.
            cell.CellFormat.Borders.SetBorders(MultipleBorderTypes.Outside, borderStyles[row], Color.Red, 2d);

            return cell;
        })));

// Document will be saved to the Desktop.
var path = System.IO.Path.Combine(Environment.GetFolderPath(Environment.SpecialFolder.Desktop), "Borders.docx");

// Save the document.
doc.Save(path);

// Open the document in Microsoft Word.
System.Diagnostics.Process.Start(path);

' Get all border styles.
Dim borderStyles As BorderStyle() = System.Enum.GetValues(GetType(BorderStyle))

' Create a new empty document.
Dim doc = New DocumentModel()

' Insert a table with 1 column and 'borderStyles.Length' rows.
doc.Sections.Add(
    New Section(doc,
        New Table(doc, borderStyles.Length, 1,
            Function(row, column)
                ' Create a new table cell with text taken from 'borderStyles' array at index 'row'.
                Dim cell = New TableCell(doc, New Paragraph(doc, borderStyles(row).ToString()))

                ' Set cell outside borders to red color, with width of 2 points and with border style taken from 'borderStyles' array at index 'row'.
                cell.CellFormat.Borders.SetBorders(MultipleBorderTypes.Outside, borderStyles(row), Color.Red, 2.0)

                Return cell
            End Function)))

' Document will be saved on the Desktop.
Dim path = System.IO.Path.Combine(Environment.GetFolderPath(Environment.SpecialFolder.Desktop), "Borders.docx")

' Save the document.
doc.Save(path)

' Open the document in Microsoft Word.
System.Diagnostics.Process.Start(path)

Reference

GemBox.Document Namespace

GemBox.DocumentSingleBorder

GemBox.DocumentMultipleBorders