GemBox.Pdf
  • Overview
  • Examples
  • Free version
  • Support
  • Pricelist

    Show / Hide Table of Contents

    PdfLinkAppearance Class

    Namespace:
    GemBox.Pdf.Annotations
    Assembly:
    GemBox.Pdf.dll

    Represents an appearance settings for a PdfLinkAnnotation.

    • C#
    • VB.NET
    public sealed class PdfLinkAppearance : PdfAppearance
    Public NotInheritable Class PdfLinkAppearance
        Inherits PdfAppearance
    Inheritance:
    System.Object
    PdfAppearance
    PdfLinkAppearance

    Properties

    BorderColor

    Gets or sets the border color of the link annotation's appearance.

    • C#
    • VB.NET
    public PdfColor? BorderColor { get; set; }
    Public Property BorderColor As PdfColor?
    Property Value
    System.Nullable<PdfColor>

    The border color of the link annotation's appearance.

    Exceptions
    System.ArgumentException

    The value's Space is not device color space (DeviceGray, DeviceRGB, or DeviceCMYK).

    See Also
    PDF Specification ISO 32000-1:2008, section '12.5.6.5 Link Annotations'

    BorderDashPattern

    Gets or sets the border dash pattern of the link annotation's appearance.

    • C#
    • VB.NET
    public PdfLineDashPattern BorderDashPattern { get; set; }
    Public Property BorderDashPattern As PdfLineDashPattern
    Property Value
    PdfLineDashPattern

    The border dash pattern of the link annotation's appearance.

    See Also
    PDF Specification ISO 32000-1:2008, section '12.5.6.5 Link Annotations'

    BorderStyle

    Gets or sets the border style of the link annotation's appearance.

    • C#
    • VB.NET
    public PdfBorderStyle BorderStyle { get; set; }
    Public Property BorderStyle As PdfBorderStyle
    Property Value
    PdfBorderStyle

    The border style of the link annotation's appearance.

    Exceptions
    System.NotSupportedException

    Value Unknown of enumeration PdfBorderStyle is not supported in the requested operation.

    See Also
    PDF Specification ISO 32000-1:2008, section '12.5.6.5 Link Annotations'

    BorderWidth

    Gets or sets the border thickness of the link annotation's appearance.

    • C#
    • VB.NET
    public double BorderWidth { get; set; }
    Public Property BorderWidth As Double
    Property Value
    System.Double

    The border thickness of the link annotation's appearance.

    Exceptions
    System.ArgumentOutOfRangeException

    Value is less than 0.

    System.ArgumentException

    Value is either System.Double.NaN, System.Double.NegativeInfinity or System.Double.PositiveInfinity.

    See Also
    PDF Specification ISO 32000-1:2008, section '12.5.6.5 Link Annotations'

    Inherited Properties

    State

    (Required if the appearance dictionary AP contains one or more subdictionaries; PDF 1.2) The annotation's appearance state, which selects the applicable appearance stream from an appearance subdictionary (see Section 12.5.5, "Appearance Streams").

    (Inherited from PdfAppearance)

    Inherited Methods

    BeginInit()

    Begins initialization of the PdfAppearance.

    Call EndInit() to end the initialization and update the appearance.

    If BeginInit() is called on a PdfAppearance that is already being initialized, the second and subsequent calls are ignored.

    (Inherited from PdfAppearance)

    EndInit()

    Ends initialization of the PdfAppearance by updating the changed appearance.

    This method will be ignored if called on a PdfAppearance that is not being initialized.

    (Inherited from PdfAppearance)

    Get()

    Gets the appearance form for the Normal appearance trigger and the current appearance State.

    (Inherited from PdfAppearance)

    Get(PdfAppearanceTrigger)

    Gets a collection of appearance states and the associated appearance forms for the specified appearance trigger.

    (Inherited from PdfAppearance)

    Get(PdfAppearanceTrigger, PdfAppearanceState)

    Gets the appearance form for the specified appearance trigger and appearance state.

    (Inherited from PdfAppearance)

    Refresh()

    Forces an update of the appearance.

    (Inherited from PdfAppearance)

    Set(PdfAppearanceTrigger, System.Collections.Generic.ICollection<System.Collections.Generic.KeyValuePair<PdfAppearanceState, PdfForm>>)

    Sets a collection of appearance states and the associated appearance forms for the specified appearance trigger.

    (Inherited from PdfAppearance)

    Set(PdfAppearanceTrigger, PdfAppearanceState, PdfForm)

    Sets the appearance form for the specified appearance trigger and appearance state.

    (Inherited from PdfAppearance)

    Set(PdfForm)

    Sets the appearance form for the Normal appearance trigger and the current appearance State.

    (Inherited from PdfAppearance)

    See Also

    PDF Specification ISO 32000-1:2008, section '12.5.6.5 Link Annotations'
    Back to top

    Facebook • Twitter • LinkedIn

    © GemBox Ltd. — All rights reserved.