HideAnnotations Property

Summary

Gets or sets a value that indicates whether to hide the annotation objects when loading a PDF page as a raster image or an SVG.

Syntax

C++/CLI

Java

Python

public bool HideAnnotations { get; set; }

public boolean getHideAnnotations() 
public void setHideAnnotations(boolean value)

public: 
property bool HideAnnotations { 
   bool get(); 
   void set (    bool ); 
}

HideAnnotations # get and set (CodecsPdfLoadOptions)

Property Value

Value	Description
true	To hide the annotation objects. The default value is true.
false	To show all annotation objects. The default value is false.

Remarks

HideAnnotations, HideFormFields and HideDigitalSignatures control showing/hiding the annotations/form fields/digital signature respectively when loading a PDF as a raster image or SVG.

The default value of these properties is true. Therefore, if you load a page containing any of these objects as a raster image or an SVG (using Load or LoadSvg), the objects will be rendered and are considered part of the page. This default behavior ensures that viewing applications will display the PDF page exactly as is.

For more document-oriented viewing applications, it may be desirable to hide these objects when loading the page. For example, an annotations-capable application can set HideAnnotations to true and then use other parts of LEADTOOLS to load the annotations and overlay them on the page for editing. Otherwise, when the user moves an object in the application, the page will show the pre-rendered version underneath.

Similarly, a PDF forms application can hide the form's fields by setting HideFormFields to true and then loading the form's fields and overlaying them using other parts of LEADTOOLS.

For a practice, refer to the source code in the Document Viewer, Annotations, PDF Document, PDF Forms and PDF Digital Signature demos in your LEADTOOLS installation.

Requirements

Target Platforms

Reference

CodecsPdfLoadOptions Class

CodecsPdfLoadOptions Members

Download our FREE evaluation

Help Version 23.0.2024.2.29

Leadtools.Codecs Assembly

Introduction

Getting Started

Namespaces

Leadtools.Codecs Namespace

Assemblies