Class PdfViewerCustomStampSettings

Represents the settings for custom stamps in a PDF viewer component in Blazor applications.

Inheritance
System.Object
PdfViewerAnnotationSettings
PdfViewerShapeSettings
PdfViewerHandwrittenSignatureSettings
PdfViewerCustomStampSettings
Inherited Members
Namespace: Syncfusion.Blazor.SfPdfViewer
Assembly: Syncfusion.Blazor.SfPdfViewer.dll
Syntax
public class PdfViewerCustomStampSettings : PdfViewerHandwrittenSignatureSettings
Remarks

This class provides functionality to manage and initialize settings for custom stamps in a PDF viewer, such as adding custom stamps to the menu, enabling custom stamp functionality, and maintaining a list of custom stamps. It ensures that the custom stamp settings are properly initialized and updated whenever parameters are set or changed.

Examples

Below is an example of how to use PdfViewerCustomStampSettings in a Blazor component:





@code {
   public List<PdfViewerCustomStamp> pdfViewerCustomStamps = new List<PdfViewerCustomStamp>()
   {
       new PdfViewerCustomStamp()
       {
            CustomStampName = "Stamp",
            // Replace the 'ImageBase64' with the actual base64 string of the image.
            CustomStampImageSource ="ImageBase64"
        }
    };
}

Constructors

PdfViewerCustomStampSettings()

Declaration
public PdfViewerCustomStampSettings()

Properties

_customStamps

Declaration
public List<PdfViewerCustomStamp> _customStamps { get; set; }
Property Value
Type
System.Collections.Generic.List<PdfViewerCustomStamp>

CustomStamps

Gets or sets a collection of custom stamps for the PDF Viewer.

Declaration
public List<PdfViewerCustomStamp> CustomStamps { get; set; }
Property Value
Type
System.Collections.Generic.List<PdfViewerCustomStamp>

EnableCustomStamp

If it is set as false, then we can't add the custom stamp annoation in the PDF Viewer. By default it is true.

Declaration
public bool EnableCustomStamp { get; set; }
Property Value
Type
System.Boolean

IsAddToMenu

Specifies to maintain the newly added custom stamp element in the menu items. By default it is false

Declaration
public bool IsAddToMenu { get; set; }
Property Value
Type
System.Boolean

JsNamespace

Declaration
protected override string JsNamespace { get; set; }
Property Value
Type
System.String
Overrides

JsProperty

Declaration
protected override string JsProperty { get; set; }
Property Value
Type
System.String
Overrides

MainParent

Declaration
protected override SfBaseComponent MainParent { get; set; }
Property Value
Type
SfBaseComponent
Overrides

SfTagIndex

Declaration
protected override int SfTagIndex { get; set; }
Property Value
Type
System.Int32
Overrides

Methods

BuildRenderTree(RenderTreeBuilder)

Declaration
protected override void BuildRenderTree(RenderTreeBuilder __builder)
Parameters
Type Name Description
Microsoft.AspNetCore.Components.Rendering.RenderTreeBuilder __builder
Overrides

OnInitializedAsync()

Declaration
protected override Task OnInitializedAsync()
Returns
Type
System.Threading.Tasks.Task
Overrides

OnParametersSetAsync()

Declaration
protected override Task OnParametersSetAsync()
Returns
Type
System.Threading.Tasks.Task
Overrides