menu

ASP.NET Core - EJ2

  • Code Examples
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class PdfViewerInkAnnotationSettingsBuilder - API Reference

    Show / Hide Table of Contents

    Class PdfViewerInkAnnotationSettingsBuilder

    Inheritance
    System.Object
    ControlBuilder
    PdfViewerInkAnnotationSettingsBuilder
    Inherited Members
    ControlBuilder.Output
    ControlBuilder.Context
    Namespace: Syncfusion.EJ2.PdfViewer
    Assembly: Syncfusion.EJ2.dll
    Syntax
    public class PdfViewerInkAnnotationSettingsBuilder : ControlBuilder

    Constructors

    PdfViewerInkAnnotationSettingsBuilder()

    Declaration
    public PdfViewerInkAnnotationSettingsBuilder()

    PdfViewerInkAnnotationSettingsBuilder(PdfViewerInkAnnotationSettings)

    Declaration
    public PdfViewerInkAnnotationSettingsBuilder(PdfViewerInkAnnotationSettings model)
    Parameters
    Type Name Description
    PdfViewerInkAnnotationSettings model

    Methods

    AllowedInteractions(Object)

    Gets or sets the allowed interactions for the locked ink annotations. IsLock can be configured using ink settings.

    Declaration
    public PdfViewerInkAnnotationSettingsBuilder AllowedInteractions(object value)
    Parameters
    Type Name Description
    System.Object value
    Returns
    Type Description
    PdfViewerInkAnnotationSettingsBuilder

    AnnotationSelectorSettings(Object)

    Define the default option to customize the selector for ink annotation.

    Declaration
    public PdfViewerInkAnnotationSettingsBuilder AnnotationSelectorSettings(object value)
    Parameters
    Type Name Description
    System.Object value
    Returns
    Type Description
    PdfViewerInkAnnotationSettingsBuilder

    Author(String)

    specifies the author of the annotation.

    Declaration
    public PdfViewerInkAnnotationSettingsBuilder Author(string value)
    Parameters
    Type Name Description
    System.String value
    Returns
    Type Description
    PdfViewerInkAnnotationSettingsBuilder

    CustomData(Object)

    specifies the custom data of the annotation

    Declaration
    public PdfViewerInkAnnotationSettingsBuilder CustomData(object value)
    Parameters
    Type Name Description
    System.Object value
    Returns
    Type Description
    PdfViewerInkAnnotationSettingsBuilder

    Height(Double)

    specifies the height of the annotation.

    Declaration
    public PdfViewerInkAnnotationSettingsBuilder Height(double value)
    Parameters
    Type Name Description
    System.Double value
    Returns
    Type Description
    PdfViewerInkAnnotationSettingsBuilder

    IsLock(Boolean)

    If it is set as true, can't interact with annotation. Otherwise can interact the annotations. By default it is false.

    Declaration
    public PdfViewerInkAnnotationSettingsBuilder IsLock(bool value)
    Parameters
    Type Name Description
    System.Boolean value
    Returns
    Type Description
    PdfViewerInkAnnotationSettingsBuilder

    IsPrint(Boolean)

    specifies whether the individual annotations are included or not in print actions.

    Declaration
    public PdfViewerInkAnnotationSettingsBuilder IsPrint(bool value)
    Parameters
    Type Name Description
    System.Boolean value
    Returns
    Type Description
    PdfViewerInkAnnotationSettingsBuilder

    Offset(Object)

    Get or set offset of the annotation.

    Declaration
    public PdfViewerInkAnnotationSettingsBuilder Offset(object value)
    Parameters
    Type Name Description
    System.Object value
    Returns
    Type Description
    PdfViewerInkAnnotationSettingsBuilder

    Opacity(Double)

    Sets the opacity value for ink annotation.By default value is 1. It range varies from 0 to 1.

    Declaration
    public PdfViewerInkAnnotationSettingsBuilder Opacity(double value)
    Parameters
    Type Name Description
    System.Double value
    Returns
    Type Description
    PdfViewerInkAnnotationSettingsBuilder

    PageNumber(Double)

    Get or set page number of the annotation.

    Declaration
    public PdfViewerInkAnnotationSettingsBuilder PageNumber(double value)
    Parameters
    Type Name Description
    System.Double value
    Returns
    Type Description
    PdfViewerInkAnnotationSettingsBuilder

    Path(String)

    Gets or sets the path of the ink annotation.

    Declaration
    public PdfViewerInkAnnotationSettingsBuilder Path(string value)
    Parameters
    Type Name Description
    System.String value
    Returns
    Type Description
    PdfViewerInkAnnotationSettingsBuilder

    StrokeColor(String)

    Sets the stroke color for ink annotation.By default values is #FF0000.

    Declaration
    public PdfViewerInkAnnotationSettingsBuilder StrokeColor(string value)
    Parameters
    Type Name Description
    System.String value
    Returns
    Type Description
    PdfViewerInkAnnotationSettingsBuilder

    Thickness(Double)

    Sets the thickness for the ink annotation. By default value is 1. It range varies from 1 to 10.

    Declaration
    public PdfViewerInkAnnotationSettingsBuilder Thickness(double value)
    Parameters
    Type Name Description
    System.Double value
    Returns
    Type Description
    PdfViewerInkAnnotationSettingsBuilder

    Width(Double)

    specifies the width of the annotation.

    Declaration
    public PdfViewerInkAnnotationSettingsBuilder Width(double value)
    Parameters
    Type Name Description
    System.Double value
    Returns
    Type Description
    PdfViewerInkAnnotationSettingsBuilder
    Back to top Generated by DocFX
    Copyright © 2001 - 2023 Syncfusion Inc. All Rights Reserved