Class PageOrganizerSettings

Defines the settings for page organization features in the PDF Viewer.

Inheritance

object

PageOrganizerSettings

Namespace: Syncfusion.Blazor.SfPdfViewer

Assembly: Syncfusion.Blazor.SfPdfViewer.dll

Syntax

public class PageOrganizerSettings : SfBaseComponent

Remarks

Use this class to configure various page manipulation capabilities such as deletion, insertion, rotation, duplication, and more. These settings allow customization of user interactions with pages in the PDF Viewer.

Examples

<SfPdfViewer2 Height="100%" Width="100%" DocumentPath="wwwroot/Annotation.pdf"> 
    <PageOrganizerSettings CanDelete="true" CanInsert="true" CanRotate="true" CanDuplicate="true" CanRearrange="true" 
        CanImport="true" ImageZoom="3" ShowImageZoomingSlider="true" ImageZoomMin="2" ImageZoomMax="4" CanExtractPages="true"></PageOrganizerSettings> 
</SfPdfViewer2>

Constructors

PageOrganizerSettings()

Declaration

public PageOrganizerSettings()

Properties

CanDelete

Enables or disables the ability to delete pages in the PDF Viewer.

Declaration

[Parameter]
[JsonPropertyName("canDelete")]
public bool CanDelete { get; set; }

Property Value

Type	Description
bool	A bool value indicating whether page deletion is permitted. Defaults to true.

Remarks

Set to true to allow users to delete pages from the document. Set to false to disable page deletion.

Examples

<SfPdfViewer2 Height="100%" Width="100%" DocumentPath="wwwroot/Annotation.pdf"> 
    <PageOrganizerSettings CanDelete="false"></PageOrganizerSettings> 
</SfPdfViewer2>

CanDuplicate

Enables or disables the ability to duplicate pages in the PDF Viewer.

Declaration

[Parameter]
[JsonPropertyName("canDuplicate")]
public bool CanDuplicate { get; set; }

Property Value

Type	Description
bool	A bool value indicating whether page duplication is enabled. Defaults to true.

Remarks

Set to true to allow users to duplicate existing pages.

Examples

<SfPdfViewer2 Height="100%" Width="100%" DocumentPath="wwwroot/Annotation.pdf"> 
    <PageOrganizerSettings CanDuplicate="false"></PageOrganizerSettings> 
</SfPdfViewer2>

CanExtractPages

Enables or disables the ability to extract pages from the PDF document.

Declaration

[Parameter]
[JsonPropertyName("canExtractPages ")]
public bool CanExtractPages { get; set; }

Property Value

Type	Description
bool	A bool value indicating whether page extraction is allowed. Defaults to true.

Remarks

Set to true to allow users to extract pages into a separate document.

Examples

<SfPdfViewer2 Height="100%" Width="100%" DocumentPath="wwwroot/Annotation.pdf"> 
    <PageOrganizerSettings CanExtractPages="false"></PageOrganizerSettings> 
</SfPdfViewer2>

CanImport

Enables or disables the ability to import pages from other documents.

Declaration

[Parameter]
[JsonPropertyName("canImport")]
public bool CanImport { get; set; }

Property Value

Type	Description
bool	A bool value indicating whether page import is allowed. Defaults to true.

Remarks

Set to true to allow users to import pages from external PDF files.

Examples

<SfPdfViewer2 Height="100%" Width="100%" DocumentPath="wwwroot/Annotation.pdf"> 
    <PageOrganizerSettings CanImport="false"></PageOrganizerSettings> 
</SfPdfViewer2>

CanInsert

Enables or disables the ability to insert pages in the PDF Viewer.

Declaration

[Parameter]
[JsonPropertyName("canInsert")]
public bool CanInsert { get; set; }

Property Value

Type	Description
bool	A bool value indicating whether page insertion is allowed. Defaults to true.

Remarks

Set to true to allow users to insert new pages into the document.

Examples

<SfPdfViewer2 Height="100%" Width="100%" DocumentPath="wwwroot/Annotation.pdf"> 
    <PageOrganizerSettings CanInsert="false"></PageOrganizerSettings> 
</SfPdfViewer2>

CanRearrange

Enables or disables the ability to rearrange pages in the PDF Viewer.

Declaration

[Parameter]
[JsonPropertyName("canRearrange")]
public bool CanRearrange { get; set; }

Property Value

Type	Description
bool	A bool value indicating whether page rearrangement is permitted. Defaults to true.

Remarks

Set to true to allow users to change the order of pages.

Examples

<SfPdfViewer2 Height="100%" Width="100%" DocumentPath="wwwroot/Annotation.pdf"> 
    <PageOrganizerSettings CanRearrange="false"></PageOrganizerSettings> 
</SfPdfViewer2>

CanRotate

Enables or disables the ability to rotate pages in the PDF Viewer.

Declaration

[Parameter]
[JsonPropertyName("canRotate")]
public bool CanRotate { get; set; }

Property Value

Type	Description
bool	A bool value indicating whether page rotation is enabled. Defaults to true.

Remarks

Set to true to allow users to rotate pages clockwise or counterclockwise.

Examples

<SfPdfViewer2 Height="100%" Width="100%" DocumentPath="wwwroot/Annotation.pdf"> 
    <PageOrganizerSettings CanRotate="false"></PageOrganizerSettings> 
</SfPdfViewer2>

FooterButtons

Specifies which buttons are visible in the Page Organizer dialog footer.

Declaration

[Parameter]
[JsonPropertyName("footerButtons")]
public FooterButton FooterButtons { get; set; }

Property Value

Type	Description
FooterButton	A FooterButtons enum value that determines which footer buttons are shown. Defaults to FooterButton.Save | FooterButton.SaveAs.

Remarks

Use this property to control the visibility of "Save" and "SaveAs" buttons:

• FooterButton.Save: Show only the "Save" button.
• FooterButton.SaveAs: Show only the "SaveAs" button.
• FooterButton.Save | FooterButton.SaveAs: Show both buttons (default).
• FooterButtons.None: Hide both buttons.

Examples

<SfPdfViewer2 Height="100%" Width="100%" DocumentPath="wwwroot/Annotation.pdf"> 
    <PageOrganizerSettings FooterButtons="FooterButton.Save"></PageOrganizerSettings> 
</SfPdfViewer2>

ImageZoom

Set the image zoom value in the PDF Viewer.

Declaration

[Parameter]
[JsonPropertyName("imageZoom")]
public double ImageZoom { get; set; }

Property Value

Type	Description
double	A double value indicating the current zoom level of images. Defaults to 1.

Remarks

• Represents the current zoom value of the images in the page organizer view. Acceptable range: 1 to 5.
• If a value greater than 5 is provided, it will be set to 5.
• If a value less than 1 is provided, it will be set to 1.

Examples

<SfPdfViewer2 Height="100%" Width="100%" DocumentPath="wwwroot/Annotation.pdf"> 
    <PageOrganizerSettings ImageZoom="3"></PageOrganizerSettings> 
</SfPdfViewer2>

ImageZoomMax

Specifies the maximum zoom level for images in the PDF Viewer.

Declaration

[Parameter]
[JsonPropertyName("imageZoomMax")]
public int ImageZoomMax { get; set; }

Property Value

Type	Description
int	An int value representing the maximum zoom factor for the image zooming slider. Defaults to 5. Acceptable values: 2 to 5.

Remarks

Maximum value for the image zooming slider in the page organizer view.

Examples

<SfPdfViewer2 Height="100%" Width="100%" DocumentPath="wwwroot/Annotation.pdf"> 
    <PageOrganizerSettings ImageZoomMax="5"></PageOrganizerSettings> 
</SfPdfViewer2>

ImageZoomMin

Specifies the minimum zoom level for images in the PDF Viewer.

Declaration

[Parameter]
[JsonPropertyName("imageZoomMin")]
public int ImageZoomMin { get; set; }

Property Value

Type	Description
int	An int value representing the minimum zoom factor for the image zooming slider. Defaults to 1. Acceptable values: 1 to 4.

Remarks

Minimum value for the image zooming slider in the page organizer view.

Examples

<SfPdfViewer2 Height="100%" Width="100%" DocumentPath="wwwroot/Annotation.pdf"> 
    <PageOrganizerSettings ImageZoomMin="1" /> 
</SfPdfViewer2>

JsNamespace

Declaration

protected virtual string JsNamespace { get; set; }

Property Value

Type
string

SfTagIndex

Declaration

protected virtual int SfTagIndex { get; set; }

Property Value

Type
int

ShowImageZoomingSlider

Shows or hides the image zooming slider in the PDF Viewer.

Declaration

[Parameter]
[JsonPropertyName("showImageZoomingSlider")]
public bool ShowImageZoomingSlider { get; set; }

Property Value

Type	Description
bool	A bool value indicating whether the image zooming slider is visible. Defaults to true.

Remarks

Set to true to display the zoom slider for images.

Examples

<SfPdfViewer2 Height="100%" Width="100%" DocumentPath="wwwroot/Annotation.pdf"> 
    <PageOrganizerSettings ShowImageZoomingSlider="false"></PageOrganizerSettings> 
</SfPdfViewer2>

jsProperty

Declaration

protected string jsProperty { get; set; }

Property Value

Type
string

mainParent

Declaration

protected SfBaseComponent mainParent { get; set; }

Property Value

Type
SfBaseComponent

Methods

BuildRenderTree(RenderTreeBuilder)

Declaration

protected override void BuildRenderTree(RenderTreeBuilder __builder)

Parameters

Type	Name	Description
RenderTreeBuilder	__builder

OnInitializedAsync()

Declaration

protected override Task OnInitializedAsync()

Returns

Type
Task

OnParametersSetAsync()

Declaration

protected override Task OnParametersSetAsync()

Returns

Type
Task