Index

  1. \setasign\SetaPDF2
    1. Core
      1. Document
      2. Document
        1. Page
        2. Page
          1. Annotation
            1. AdditionalActions
            2. Annotation
            3. AppearanceCharacteristics
            4. BorderEffect
            5. BorderStyle
            6. CaretAnnotation
            7. CircleAnnotation
            8. FileAttachmentAnnotation
            9. Flags
            10. FreeTextAnnotation
            11. HighlightAnnotation
            12. InkAnnotation
            13. LineAnnotation
            14. LineEndingStyle
            15. LinkAnnotation
            16. MarkupAnnotation
            17. PolyLineAnnotation
            18. PolygonAnnotation
            19. PopupAnnotation
            20. QuadPointsTrait
            21. ScreenAnnotation
            22. SquareAnnotation
            23. SquigglyAnnotation
            24. StampAnnotation
            25. StrikeOutAnnotation
            26. TextAnnotation
            27. TextMarkupAnnotation
            28. UnderlineAnnotation
            29. Widget
            30. WidgetAnnotation

setasign\SetaPDF2\Core\Document\Page\Annotation

BorderStyle Class representing annotations border style dictionary

File: /SetaPDF v2/Core/Document/Page/Annotation/BorderStyle.php
Old class name (alias): \SetaPDF_Core_Document_Page_Annotation_BorderStyle

See PDF 32000-1:2008 - 12.5.4 Border Styles

Class hierarchy

Summary

Methods

Properties

Constants

Constants

BEVELED

public const string BorderStyle::BEVELED = 'B'

Border style

DASHED

public const string BorderStyle::DASHED = 'D'

Border style

INSET

public const string BorderStyle::INSET = 'I'

Border style

SOLID

public const string BorderStyle::SOLID = 'S'

Border style

UNDERLINE

public const string BorderStyle::UNDERLINE = 'U'

Border style


Properties

$_annotation

protected \SetaPDF_Core_Document_Page_Annotation BorderStyle::$_annotation

The dictionary


Methods

__construct()

public BorderStyle::__construct ()

The constructor.

Parameters
$annotation : \SetaPDF_Core_Document_Page_Annotation
 

cleanUp()

public BorderStyle::cleanUp (
void
): void

Release memory/cycled references.

getDashPattern()

public BorderStyle::getDashPattern (
void
): ?array

Get the dash pattern.

Exceptions

Throws \setasign\SetaPDF2\Core\Type\Exception

getDictionary()

public BorderStyle::getDictionary (
bool $create = false
): \SetaPDF_Core_Type_Dictionary

Get the dictionary of it.

Parameters
$create : bool

Defines whether the dictionary should be created if it doesn't exists

getStyle()

public BorderStyle::getStyle (
void
): string

Get the border style.

Exceptions

Throws \setasign\SetaPDF2\Core\Type\Exception

getWidth()

public BorderStyle::getWidth (
void
): int|float

Get the border width.

Exceptions

Throws \setasign\SetaPDF2\Core\Type\Exception

setDashPattern()

public BorderStyle::setDashPattern (
array|\SetaPDF_Core_Type_Array $pattern
): self

Set the dash pattern.

Parameters
$pattern : array|\SetaPDF_Core_Type_Array
 

setStyle()

public BorderStyle::setStyle (
?string $style
): self

Set the border style.

Parameters
$style : ?string
 

setWidth()

public BorderStyle::setWidth (
null|int|float $width
): self

Set the border width.

Parameters
$width : null|int|float
 

© 2025 Setasign GmbH & Co. KG · Contact / Imprint · Data Privacy Statement (German)