Groupdocs API References – com.groupdocs.watermark.common

Java: Attachment

Mon, 01 Jan 0001 00:00:00 +0000

Inheritance: java.lang.Object

public abstract class Attachment

Represents a file attached to a document.

Learn more

Methods

Method	Description
getDocumentInfo()	Gets the information about a document stored in the attached file.
getContent()	Gets the attached file content.
setContent(byte[] value)	Sets the attached file content.
createWatermarker()	Loads a content from the attached file.
createWatermarker(LoadOptions loadOptions)	Loads a content from the attached file with the specified load options.
createWatermarker(LoadOptions loadOptions, WatermarkerSettings watermarkerSettings)	Loads a content from the attached file with the specified load options and settings.
getContentStream()	Gets a stream from the attached file.
setContentStream(System.IO.Stream stream)	Updates attached file from a stream.
updateContent(Watermarker updatedVersion)	Updates the attached content.

getDocumentInfo()

public final IDocumentInfo getDocumentInfo()

Gets the information about a document stored in the attached file.

Returns: IDocumentInfo - The [IDocumentInfo](../../com.groupdocs.watermark.common/idocumentinfo) instance that contains detected information.

getContent()

public abstract byte[] getContent()

Gets the attached file content.

Returns: byte[] - The attached file content.

setContent(byte[] value)

public abstract void setContent(byte[] value)

Sets the attached file content.

Parameters:

Parameter	Type	Description
value	byte[]	The attached file content.

createWatermarker()

public final Watermarker createWatermarker()

Loads a content from the attached file.

Returns: Watermarker - The instance of appropriate descendant of [Content](../../com.groupdocs.watermark.contents/content) class.

createWatermarker(LoadOptions loadOptions)

public final Watermarker createWatermarker(LoadOptions loadOptions)

Loads a content from the attached file with the specified load options.

Parameters:

Parameter	Type	Description
loadOptions	LoadOptions	Additional options to use when loading an attachment content.

Returns: Watermarker - The instance of appropriate descendant of [Content](../../com.groupdocs.watermark.contents/content) class.

createWatermarker(LoadOptions loadOptions, WatermarkerSettings watermarkerSettings)

public final Watermarker createWatermarker(LoadOptions loadOptions, WatermarkerSettings watermarkerSettings)

Loads a content from the attached file with the specified load options and settings.

Parameters:

Parameter	Type	Description
loadOptions	LoadOptions	Additional options to use when loading an attachment content.
watermarkerSettings	WatermarkerSettings	Additional settings to use when working with loaded document.

Returns: Watermarker - The instance of appropriate descendant of [Content](../../com.groupdocs.watermark.contents/content) class.

getContentStream()

public System.IO.Stream getContentStream()

Gets a stream from the attached file.

Returns: com.aspose.ms.System.IO.Stream - The stream to read the file content from.

setContentStream(System.IO.Stream stream)

public void setContentStream(System.IO.Stream stream)

Updates attached file from a stream.

Parameters:

Parameter	Type	Description
stream	com.aspose.ms.System.IO.Stream	The stream to update attached file from.

updateContent(Watermarker updatedVersion)

public final void updateContent(Watermarker updatedVersion)

Updates the attached content.

Parameters:

Parameter	Type	Description
updatedVersion	Watermarker	The updated version of the content.

Java: Dimension

Mon, 01 Jan 0001 00:00:00 +0000

Inheritance: java.lang.Object

public final class Dimension

Represents dimensions of a 2d object.

Fields

Field	Description
Width	Object width.
Height	Object height.

Width

public static final int Width

Object width.

Height

public static final int Height

Object height.

Java: FileType

Mon, 01 Jan 0001 00:00:00 +0000

Inheritance: java.lang.Object

public final class FileType

Represents file type.

This class provides methods to obtain list of all file types supported by GroupDocs.Watermark.

Learn more

Fields

Field	Description
Unknown	Represents unknown file type.
OOXML	Office open xml file (.ooxml).
VSD	VSD files are drawings created with Microsoft Visio application to represent variety of graphical objects and the interconnection between these.
VSDX	Files with .VSDX extension represent Microsoft Visio file format introduced from Microsoft Office 2013 onwards.
VSS	VSS are stencil files created with Microsoft Visio 2007 and earlier.
VSSX	Files with .VSSX extension are drawing stencils created with Microsoft Visio 2013 and above.
VSDM	Files with VSDM extension are drawing files created with Microsoft Visio application that supports macros.
VST	Files with VST extension are vector image files created with Microsoft Visio and act as template for creating further files.
VSTX	Files with VSTX extensions are drawing template files created with Microsoft Visio 2013 and above.
VSTM	Files with VSTM extension are template files created with Microsoft Visio that support macros.
VSSM	Files with .VSSM extension are Microsoft Visio Stencil files that support provide support for macros.
VSX	Files with .VSX extension refer to stencils that consist of drawings and shapes that are used for creating diagrams in Microsoft Visio.
VTX	A file with VTX extension is a Microsoft Visio drawing template that is saved to disc in XML file format.
VDW	VDW is the Visio Graphics Service file format that specifies the streams and storages required for rendering a Web drawing.
VDX	Any drawing or chart created in Microsoft Visio, but saved in XML format have .VDX extension.
MSG	MSG is a file format used by Microsoft Outlook and Exchange to store email messages, contact, appointment, or other tasks.
EML	EML file format represents email messages saved using Outlook and other relevant applications.
EMLX	The EMLX file format is implemented and developed by Apple.
OFT	Files with .OFT extension represent message template files that are created using Microsoft Outlook.
TIF	TIFF or TIF, Tagged Image File Format, represents raster images that are meant for usage on a variety of devices that comply with this file format standard.
TIFF	TIFF or TIF, Tagged Image File Format, represents raster images that are meant for usage on a variety of devices that comply with this file format standard.
JPG	A JPEG is a type of image format that is saved using the method of lossy compression.
JPEG	A JPEG is a type of image format that is saved using the method of lossy compression.
PNG	PNG, Portable Network Graphics, refers to a type of raster image file format that use loseless compression.
GIF	A GIF or Graphical Interchange Format is a type of highly compressed image.
BMP	Files having extension .BMP represent Bitmap Image files that are used to store bitmap digital images.
JPF	JPEG 2000 (JPF) is an image coding system and state-of-the-art image compression standard.
JPX	JPEG 2000 (JPX) is an image coding system and state-of-the-art image compression standard.
JPM	JPEG 2000 (JPM) is an image coding system and state-of-the-art image compression standard.
WEBP	WebP, introduced by Google, is a modern raster web image file format that is based on lossless and lossy compression.
PDF	Portable Document Format (PDF) is a type of document created by Adobe back in 1990s.
PPT	A file with PPT extension represents PowerPoint file that consists of a collection of slides for displaying as SlideShow.
PPTX	Files with PPTX extension are presentation files created with popular Microsoft PowerPoint application.
PPS	PPS, PowerPoint Slide Show, files are created using Microsoft PowerPoint for Slide Show purpose.
PPSX	PPSX, Power Point Slide Show, file are created using Microsoft PowerPoint 2007 and above for Slide Show purpose.
PPTM	Files with PPTM extension are Macro-enabled Presentation files that are created with Microsoft PowerPoint 2007 or higher versions.
POTX	Files with .POTX extension represent Microsoft PowerPoint template presentations that are created with Microsoft PowerPoint 2007 and above.
POTM	Files with POTM extension are Microsoft PowerPoint template files with support for Macros.
PPSM	Files with PPSM extension represent Macro-enabled Slide Show file format created with Microsoft PowerPoint 2007 or higher.
XLS	Files with XLS extension represent Excel Binary File Format.
XLSX	XLSX is well-known format for Microsoft Excel documents that was introduced by Microsoft with the release of Microsoft Office 2007.
XLSM	Files with XLSM extension is a type of Spreasheet files that support Macros.
XLTX	Files with XLTX extension represent Microsoft Excel Template files that are based on the Office OpenXML file format specifications.
XLTM	The XLTM file extension represents files that are generated by Microsoft Excel as Macro-enabled template files.
XLSB	XLSB file format specifies the Excel Binary File Format, which is a collection of records and structures that specify Excel workbook content.
XLT	Files with .XLT extension are template files created with Microsoft Excel which is a spreadsheet application which comes as part of Microsoft Office suite.
DOC	Files with .doc extension represent documents generated by Microsoft Word or other word processing documents in binary file format.
DOCX	DOCX is a well-known format for Microsoft Word documents.
DOCM	DOCM files are Microsoft Word 2007 or higher generated documents with the ability to run macros.
DOT	Files with .DOT extension are template files created by Microsoft Word to have pre-formatted settings for generation of further DOC or DOCX files.
DOTX	Files with DOTX extension are template files created by Microsoft Word to have pre-formatted settings for generation of further DOCX files.
DOTM	A file with DOTM extension represents template file created with Microsoft Word 2007 or higher.
RTF	Introduced and documented by Microsoft, the Rich Text Format (RTF) represents a method of encoding formatted text and graphics for use within applications.
ODT	ODT files are type of documents created with word processing applications that are based on OpenDocument Text File format.
FlatOpc	Office Open XML WordprocessingML stored in a flat XML file instead of a ZIP package (.xml).
FlatOpcMacroEnabled	Office Open XML WordprocessingML Macro-Enabled Document stored in a flat XML file instead of a ZIP package (.xml).
FlatOpcTemplate	Office Open XML WordprocessingML Template (macro-free) stored in a flat XML file instead of a ZIP package (.xml).
FlatOpcTemplateMacroEnabled	Office Open XML WordprocessingML Macro-Enabled Template stored in a flat XML file instead of a ZIP package (.xml).

Methods

Method	Description
getFileFormatName()	Gets the file type name e.g., “Microsoft Word Document”.
getExtension()	Gets the file name suffix (including the period “.”) e.g., “.doc”.
getFormatFamily()	Gets the format family.
getFileFormat()
equals(FileType other)	Determines whether the current `[FileType](../../com.groupdocs.watermark.common/filetype)` is the same as the specified `[FileType](../../com.groupdocs.watermark.common/filetype)` object.
fromExtension(String extension)	Maps the file extension to the file type.
getSupportedFileTypes()	Retrieves the supported file types.
equals(Object obj)	Determines whether the current `[FileType](../../com.groupdocs.watermark.common/filetype)` is the same as the specified object.
hashCode()	Returns a hash code for the current `[FileType](../../com.groupdocs.watermark.common/filetype)` object.
op_Equality(FileType left, FileType right)	Determines whether two `[FileType](../../com.groupdocs.watermark.common/filetype)` objects are the same.
op_Inequality(FileType left, FileType right)	Determines whether two `[FileType](../../com.groupdocs.watermark.common/filetype)` objects are not the same.
toString()	Returns a string that represents the current object.
isImage()

Unknown

public static final FileType Unknown

Represents unknown file type.

OOXML

public static final FileType OOXML

Office open xml file (.ooxml).

VSD

public static final FileType VSD

VSD files are drawings created with Microsoft Visio application to represent variety of graphical objects and the interconnection between these. Learn more about this file format here.

VSDX

public static final FileType VSDX

Files with .VSDX extension represent Microsoft Visio file format introduced from Microsoft Office 2013 onwards. Learn more about this file format here.

VSS

public static final FileType VSS

VSS are stencil files created with Microsoft Visio 2007 and earlier. Stencil files provide drawing objects that can be included in a .VSD Visio drawing. Learn more about this file format here.

VSSX

public static final FileType VSSX

Files with .VSSX extension are drawing stencils created with Microsoft Visio 2013 and above. Learn more about this file format here.

VSDM

public static final FileType VSDM

Files with VSDM extension are drawing files created with Microsoft Visio application that supports macros. Learn more about this file format here.

VST

public static final FileType VST

Files with VST extension are vector image files created with Microsoft Visio and act as template for creating further files. Learn more about this file format here.

VSTX

public static final FileType VSTX

Files with VSTX extensions are drawing template files created with Microsoft Visio 2013 and above. Learn more about this file format here.

VSTM

public static final FileType VSTM

Files with VSTM extension are template files created with Microsoft Visio that support macros. Learn more about this file format here.

VSSM

public static final FileType VSSM

Files with .VSSM extension are Microsoft Visio Stencil files that support provide support for macros. Learn more about this file format here.

VSX

public static final FileType VSX

Files with .VSX extension refer to stencils that consist of drawings and shapes that are used for creating diagrams in Microsoft Visio. Learn more about this file format here.

VTX

public static final FileType VTX

A file with VTX extension is a Microsoft Visio drawing template that is saved to disc in XML file format. Learn more about this file format here.

VDW

public static final FileType VDW

VDW is the Visio Graphics Service file format that specifies the streams and storages required for rendering a Web drawing. Learn more about this file format here.

VDX

public static final FileType VDX

Any drawing or chart created in Microsoft Visio, but saved in XML format have .VDX extension. Learn more about this file format here.

MSG

public static final FileType MSG

MSG is a file format used by Microsoft Outlook and Exchange to store email messages, contact, appointment, or other tasks. Learn more about this file format here.

EML

public static final FileType EML

EML file format represents email messages saved using Outlook and other relevant applications. Learn more about this file format here.

EMLX

public static final FileType EMLX

The EMLX file format is implemented and developed by Apple. The Apple Mail application uses the EMLX file format for exporting the emails. Learn more about this file format here.

OFT

public static final FileType OFT

Files with .OFT extension represent message template files that are created using Microsoft Outlook. Learn more about this file format here.

TIF

public static final FileType TIF

TIFF or TIF, Tagged Image File Format, represents raster images that are meant for usage on a variety of devices that comply with this file format standard. Learn more about this file format here.

TIFF

public static final FileType TIFF

TIFF or TIF, Tagged Image File Format, represents raster images that are meant for usage on a variety of devices that comply with this file format standard. Learn more about this file format here.

JPG

public static final FileType JPG

A JPEG is a type of image format that is saved using the method of lossy compression. Learn more about this file format here.

JPEG

public static final FileType JPEG

A JPEG is a type of image format that is saved using the method of lossy compression. Learn more about this file format here.

PNG

public static final FileType PNG

PNG, Portable Network Graphics, refers to a type of raster image file format that use loseless compression. Learn more about this file format here.

GIF

public static final FileType GIF

A GIF or Graphical Interchange Format is a type of highly compressed image. Learn more about this file format here.

BMP

public static final FileType BMP

Files having extension .BMP represent Bitmap Image files that are used to store bitmap digital images. These images are independent of graphics adapter and are also called device independent bitmap (DIB) file format. Learn more about this file format here.

JPF

public static final FileType JPF

JPEG 2000 (JPF) is an image coding system and state-of-the-art image compression standard. Designed, using wavelet technology JPEG 2000 can code lossless content in any quality at once. Learn more about this file format here.

JPX

public static final FileType JPX

JPEG 2000 (JPX) is an image coding system and state-of-the-art image compression standard. Designed, using wavelet technology JPEG 2000 can code lossless content in any quality at once. Learn more about this file format here.

JPM

public static final FileType JPM

JPEG 2000 (JPM) is an image coding system and state-of-the-art image compression standard. Designed, using wavelet technology JPEG 2000 can code lossless content in any quality at once. Learn more about this file format here.

WEBP

public static final FileType WEBP

WebP, introduced by Google, is a modern raster web image file format that is based on lossless and lossy compression. It provides same image quality while considerably reducing the image size. Learn more about this file format here.

PDF

public static final FileType PDF

Portable Document Format (PDF) is a type of document created by Adobe back in 1990s. The purpose of this file format was to introduce a standard for representation of documents and other reference material in a format that is independent of application software, hardware as well as Operating System. Learn more about this file format here.

PPT

public static final FileType PPT

A file with PPT extension represents PowerPoint file that consists of a collection of slides for displaying as SlideShow. It specifies the Binary File Format used by Microsoft PowerPoint 97-2003. Learn more about this file format here.

PPTX

public static final FileType PPTX

Files with PPTX extension are presentation files created with popular Microsoft PowerPoint application. Unlike the previous version of presentation file format PPT which was binary, the PPTX format is based on the Microsoft PowerPoint open XML presentation file format. Learn more about this file format here.

PPS

public static final FileType PPS

PPS, PowerPoint Slide Show, files are created using Microsoft PowerPoint for Slide Show purpose. PPS file reading and creation is supported by Microsoft PowerPoint 97-2003. Learn more about this file format here.

PPSX

public static final FileType PPSX

PPSX, Power Point Slide Show, file are created using Microsoft PowerPoint 2007 and above for Slide Show purpose. Learn more about this file format here.

PPTM

public static final FileType PPTM

Files with PPTM extension are Macro-enabled Presentation files that are created with Microsoft PowerPoint 2007 or higher versions. Learn more about this file format here.

POTX

public static final FileType POTX

Files with .POTX extension represent Microsoft PowerPoint template presentations that are created with Microsoft PowerPoint 2007 and above. Learn more about this file format here.

POTM

public static final FileType POTM

Files with POTM extension are Microsoft PowerPoint template files with support for Macros. POTM files are created with PowerPoint 2007 or above and contains default settings that can be used to create further presentation files. Learn more about this file format here.

PPSM

public static final FileType PPSM

Files with PPSM extension represent Macro-enabled Slide Show file format created with Microsoft PowerPoint 2007 or higher. Learn more about this file format here.

XLS

public static final FileType XLS

Files with XLS extension represent Excel Binary File Format. Such files can be created by Microsoft Excel as well as other similar spreadsheet programs such as OpenOffice Calc or Apple Numbers. Learn more about this file format here.

XLSX

public static final FileType XLSX

XLSX is well-known format for Microsoft Excel documents that was introduced by Microsoft with the release of Microsoft Office 2007. Learn more about this file format here.

XLSM

public static final FileType XLSM

Files with XLSM extension is a type of Spreasheet files that support Macros. Learn more about this file format here.

XLTX

public static final FileType XLTX

Files with XLTX extension represent Microsoft Excel Template files that are based on the Office OpenXML file format specifications. Learn more about this file format here.

XLTM

public static final FileType XLTM

The XLTM file extension represents files that are generated by Microsoft Excel as Macro-enabled template files. Learn more about this file format here.

XLSB

public static final FileType XLSB

XLSB file format specifies the Excel Binary File Format, which is a collection of records and structures that specify Excel workbook content. Learn more about this file format here.

XLT

public static final FileType XLT

Files with .XLT extension are template files created with Microsoft Excel which is a spreadsheet application which comes as part of Microsoft Office suite. Learn more about this file format here.

DOC

public static final FileType DOC

Files with .doc extension represent documents generated by Microsoft Word or other word processing documents in binary file format. Learn more about this file format here.

DOCX

public static final FileType DOCX

DOCX is a well-known format for Microsoft Word documents. Introduced from 2007 with the release of Microsoft Office 2007, the structure of this new Document format was changed from plain binary to a combination of XML and binary files. Learn more about this file format here.

DOCM

public static final FileType DOCM

DOCM files are Microsoft Word 2007 or higher generated documents with the ability to run macros. Learn more about this file format here.

DOT

public static final FileType DOT

Files with .DOT extension are template files created by Microsoft Word to have pre-formatted settings for generation of further DOC or DOCX files. Learn more about this file format here.

DOTX

public static final FileType DOTX

Files with DOTX extension are template files created by Microsoft Word to have pre-formatted settings for generation of further DOCX files. Learn more about this file format here.

DOTM

public static final FileType DOTM

A file with DOTM extension represents template file created with Microsoft Word 2007 or higher. Learn more about this file format here.

RTF

public static final FileType RTF

Introduced and documented by Microsoft, the Rich Text Format (RTF) represents a method of encoding formatted text and graphics for use within applications. The format facilitates cross-platform document exchange with other Microsoft Products, thus serving the purpose of interoperability. Learn more about this file format here.

ODT

public static final FileType ODT

ODT files are type of documents created with word processing applications that are based on OpenDocument Text File format. These are created with word processor applications such as free OpenOffice Writer and can hold content such as text, images, objects and styles. Learn more about this file format here.

FlatOpc

public static final FileType FlatOpc

Office Open XML WordprocessingML stored in a flat XML file instead of a ZIP package (.xml). Learn more about this file format here.

FlatOpcMacroEnabled

public static final FileType FlatOpcMacroEnabled

Office Open XML WordprocessingML Macro-Enabled Document stored in a flat XML file instead of a ZIP package (.xml). Learn more about this file format here.

FlatOpcTemplate

public static final FileType FlatOpcTemplate

Office Open XML WordprocessingML Template (macro-free) stored in a flat XML file instead of a ZIP package (.xml). Learn more about this file format here.

FlatOpcTemplateMacroEnabled

public static final FileType FlatOpcTemplateMacroEnabled

Office Open XML WordprocessingML Macro-Enabled Template stored in a flat XML file instead of a ZIP package (.xml). Learn more about this file format here.

getFileFormatName()

public final String getFileFormatName()

Gets the file type name e.g., “Microsoft Word Document”.

Returns: java.lang.String - The file type name.

getExtension()

public final String getExtension()

Gets the file name suffix (including the period “.”) e.g., “.doc”.

Returns: java.lang.String - The file name suffix (including the period “.”).

getFormatFamily()

public final int getFormatFamily()

Gets the format family.

Returns: int - The format family.

getFileFormat()

public final int getFileFormat()

Returns: int

equals(FileType other)

public final boolean equals(FileType other)

Determines whether the current [FileType](../../com.groupdocs.watermark.common/filetype) is the same as the specified [FileType](../../com.groupdocs.watermark.common/filetype) object.

Parameters:

Parameter	Type	Description
other	FileType	The object to compare with the current `[FileType](../../com.groupdocs.watermark.common/filetype)` object.

Returns: boolean - true if both [FileType](../../com.groupdocs.watermark.common/filetype) objects are the same; otherwise, false.

fromExtension(String extension)

public static FileType fromExtension(String extension)

Maps the file extension to the file type.

Parameters:

Parameter	Type	Description
extension	java.lang.String	The file extension (including the period “.”).

Returns: FileType - When the file type is supported returns it, otherwise returns the default #Unknown.Unknown file type.

getSupportedFileTypes()

public static FileType[] getSupportedFileTypes()

Retrieves the supported file types.

Returns: com.groupdocs.watermark.common.FileType[] - Returns the sequence of the supported file types.

equals(Object obj)

public boolean equals(Object obj)

Determines whether the current [FileType](../../com.groupdocs.watermark.common/filetype) is the same as the specified object.

Parameters:

Parameter	Type	Description
obj	java.lang.Object	The object to compare with the current `[FileType](../../com.groupdocs.watermark.common/filetype)` object.

Returns: boolean - true if obj parameter is [FileType](../../com.groupdocs.watermark.common/filetype) and is the same as the current [FileType](../../com.groupdocs.watermark.common/filetype) object; otherwise, false.

hashCode()

public int hashCode()

Returns a hash code for the current [FileType](../../com.groupdocs.watermark.common/filetype) object.

Returns: int - A hash code for the current [FileType](../../com.groupdocs.watermark.common/filetype) object.

op_Equality(FileType left, FileType right)

public static boolean op_Equality(FileType left, FileType right)

Determines whether two [FileType](../../com.groupdocs.watermark.common/filetype) objects are the same.

Parameters:

Parameter	Type	Description
left	FileType	Left `[FileType](../../com.groupdocs.watermark.common/filetype)` object.
right	FileType	Right `[FileType](../../com.groupdocs.watermark.common/filetype)` object.

Returns: boolean - true if both [FileType](../../com.groupdocs.watermark.common/filetype) objects are the same; otherwise, false.

op_Inequality(FileType left, FileType right)

public static boolean op_Inequality(FileType left, FileType right)

Determines whether two [FileType](../../com.groupdocs.watermark.common/filetype) objects are not the same.

Parameters:

Parameter	Type	Description
left	FileType	Left `[FileType](../../com.groupdocs.watermark.common/filetype)` object.
right	FileType	Right `[FileType](../../com.groupdocs.watermark.common/filetype)` object.

Returns: boolean - true if both [FileType](../../com.groupdocs.watermark.common/filetype) objects are not the same; otherwise, false.

toString()

public String toString()

Returns a string that represents the current object.

Returns: java.lang.String - A string that represents the current object.

isImage()

public final boolean isImage()

Returns: boolean

Java: FormatFamily

Mon, 01 Jan 0001 00:00:00 +0000

Inheritance: java.lang.Object

public final class FormatFamily

Enumeration of supported format families.

Fields

Field	Description
Unknown	Unknown format family.
Diagram	Diagram format family.
Email	Email format family.
Image	Image format family.
MultiframeImage	Multi frame image format family.
Pdf	PDF format family.
Presentation	Presentation format family.
Spreadsheet	Spreadsheet format family.
WordProcessing	Word processing format family.

Methods

Method	Description
toString(int value)	Returns a string representation of the `[FormatFamily](../../com.groupdocs.watermark.common/formatfamily)` value.

Unknown

public static final int Unknown

Unknown format family.

Diagram

public static final int Diagram

Diagram format family.

Email

public static final int Email

Email format family.

Image

public static final int Image

Image format family.

MultiframeImage

public static final int MultiframeImage

Multi frame image format family.

Pdf

public static final int Pdf

PDF format family.

Presentation

public static final int Presentation

Presentation format family.

Spreadsheet

public static final int Spreadsheet

Spreadsheet format family.

WordProcessing

public static final int WordProcessing

Word processing format family.

toString(int value)

public static final String toString(int value)

Returns a string representation of the [FormatFamily](../../com.groupdocs.watermark.common/formatfamily) value.

Parameters:

Parameter	Type	Description
value	int	The value to convert.

Returns: java.lang.String - The string representation of the [FormatFamily](../../com.groupdocs.watermark.common/formatfamily) value.

Java: HorizontalAlignment

Mon, 01 Jan 0001 00:00:00 +0000

Inheritance: java.lang.Object

public final class HorizontalAlignment

Enumeration of possible horizontal alignment values.

Fields

Field	Description
None	No alignment (use specified position).
Left	Align to left.
Center	Center alignment.
Right	Align to right.

Methods

Method	Description
toString(int value)	Returns a string representation of the `[HorizontalAlignment](../../com.groupdocs.watermark.common/horizontalalignment)` value.
parse(String value)	Parses a string to a `[HorizontalAlignment](../../com.groupdocs.watermark.common/horizontalalignment)` enumeration value.

None

public static final int None

No alignment (use specified position).

Left

public static final int Left

Align to left.

Center

public static final int Center

Center alignment.

Right

public static final int Right

Align to right.

toString(int value)

public static final String toString(int value)

Returns a string representation of the [HorizontalAlignment](../../com.groupdocs.watermark.common/horizontalalignment) value.

Parameters:

Parameter	Type	Description
value	int	The value to convert.

Returns: java.lang.String - The string representation of the [HorizontalAlignment](../../com.groupdocs.watermark.common/horizontalalignment) value.

parse(String value)

public static final int parse(String value)

Parses a string to a [HorizontalAlignment](../../com.groupdocs.watermark.common/horizontalalignment) enumeration value.

Parameters:

Parameter	Type	Description
value	java.lang.String	The string to parse.

Returns: int - The [HorizontalAlignment](../../com.groupdocs.watermark.common/horizontalalignment) enumeration value.

Java: PageInfo

Mon, 01 Jan 0001 00:00:00 +0000

Inheritance: java.lang.Object

public final class PageInfo

Represents a document page description.

Constructors

Constructor	Description
PageInfo(int pageNumber, double width, double height)

Methods

Method	Description
getHeight()	Gets the document page height.
getWidth()	Gets the document page width.
getPageNumber()	Gets the document page number.

PageInfo(int pageNumber, double width, double height)

public PageInfo(int pageNumber, double width, double height)

Parameters:

Parameter	Type	Description
pageNumber	int
width	double
height	double

getHeight()

public final double getHeight()

Gets the document page height.

Returns: double - The document page height.

getWidth()

public final double getWidth()

Gets the document page width.

Returns: double - The document page width.

getPageNumber()

public final int getPageNumber()

Gets the document page number.

Returns: int - The document page number.

Java: ReadOnlyListBase

Mon, 01 Jan 0001 00:00:00 +0000

Inheritance: java.lang.Object

All Implemented Interfaces: com.groupdocs.watermark.internal.IReadOnlyList

public abstract class ReadOnlyListBase<T> implements IReadOnlyList<T>

Provides the abstract base class for a strongly typed read-only list.

T : The type of the element.

Methods

Method	Description
getCount()	Gets the number of elements contained in the collection.
getInnerList()
get_Item(int index)	Gets the element at the specified index in the collection.
contains(T item)	Determines whether the collection contains a specific item.
indexOf(T item)	Determines the index of a specific item in the collection.
iterator()	Returns an enumerator that iterates through a collection.
addInternally(T item)

getCount()

public int getCount()

Gets the number of elements contained in the collection.

Returns: int - The number of elements contained in the collection.

getInnerList()

public final System.Collections.Generic.List<T> getInnerList()

Returns: com.aspose.ms.System.Collections.Generic.List

get_Item(int index)

public T get_Item(int index)

Gets the element at the specified index in the collection.

Parameters:

Parameter	Type	Description
index	int	The zero-based index of the element to get. Value: The element at the specified index.

Returns: T

contains(T item)

public boolean contains(T item)

Determines whether the collection contains a specific item.

Parameters:

Parameter	Type	Description
item	T	The item to locate in the collection.

Returns: boolean - True if the item is found in the collection; otherwise, false.

indexOf(T item)

public int indexOf(T item)

Determines the index of a specific item in the collection.

Parameters:

Parameter	Type	Description
item	T	The item to locate in the collection.

Returns: int - The index of item if found in the collection; otherwise, -1.

iterator()

public Iterator<T> iterator()

Returns an enumerator that iterates through a collection.

Returns: java.util.Iterator - An IEnumerator{T} object that can be used to iterate through the collection.

addInternally(T item)

public void addInternally(T item)

Parameters:

Parameter	Type	Description
item	T

Java: RemoveOnlyListBase

Mon, 01 Jan 0001 00:00:00 +0000

Inheritance: java.lang.Object, com.groupdocs.watermark.common.ReadOnlyListBase

public abstract class RemoveOnlyListBase<T> extends ReadOnlyListBase<T>

Provides the abstract base class for a strongly typed remove-only list.

T : The type of the element.

Methods

Method	Description
isReadOnly()	Gets a value indicating whether the collection is read-only.
clear()	Removes all items from the collection.
remove(T item)	Removes the first occurrence of a specific object from the collection.
removeAt(int index)	Removes the item at the specified index.
removeFromDocument(T item)

isReadOnly()

public boolean isReadOnly()

Gets a value indicating whether the collection is read-only.

Returns: boolean - Returns true if the collection is read-only; otherwise, false.

clear()

public final void clear()

Removes all items from the collection.

remove(T item)

public final boolean remove(T item)

Removes the first occurrence of a specific object from the collection.

Parameters:

Parameter	Type	Description
item	T	The item to remove from the collection.

Returns: boolean - True if item was successfully removed; otherwise false.

removeAt(int index)

public final void removeAt(int index)

Removes the item at the specified index.

Parameters:

Parameter	Type	Description
index	int	The zero-based index of the item to remove.

removeFromDocument(T item)

public void removeFromDocument(T item)

Parameters:

Parameter	Type	Description
item	T

Java: UnitOfMeasurement

Mon, 01 Jan 0001 00:00:00 +0000

Inheritance: java.lang.Object

public final class UnitOfMeasurement

Represents units of measurement.

Fields

Field	Description
Pixel	Specifies that the unit of measurement is pixel.
Point	Specifies that the unit of measurement is point.

Methods

Method	Description
toString(int value)	Returns a string representation of the `[UnitOfMeasurement](../../com.groupdocs.watermark.common/unitofmeasurement)` value.

Pixel

public static final int Pixel

Specifies that the unit of measurement is pixel.

Point

public static final int Point

Specifies that the unit of measurement is point.

toString(int value)

public static final String toString(int value)

Returns a string representation of the [UnitOfMeasurement](../../com.groupdocs.watermark.common/unitofmeasurement) value.

Parameters:

Parameter	Type	Description
value	int	The value to convert.

Returns: java.lang.String - The string representation of the [UnitOfMeasurement](../../com.groupdocs.watermark.common/unitofmeasurement) value.

Java: VerticalAlignment

Mon, 01 Jan 0001 00:00:00 +0000

Inheritance: java.lang.Object

public final class VerticalAlignment

Enumeration of possible vertical alignment values.

Fields

Field	Description
None	No alignment (use specified position).
Top	Align to top.
Center	Center alignment.
Bottom	Align to bottom.

Methods

Method	Description
toString(int value)	Returns a string representation of the `[VerticalAlignment](../../com.groupdocs.watermark.common/verticalalignment)` value.
parse(String value)	Parses a string to a `[VerticalAlignment](../../com.groupdocs.watermark.common/verticalalignment)` enumeration value.

None

public static final int None

No alignment (use specified position).

Top

public static final int Top

Align to top.

Center

public static final int Center

Center alignment.

Bottom

public static final int Bottom

Align to bottom.

toString(int value)

public static final String toString(int value)

Returns a string representation of the [VerticalAlignment](../../com.groupdocs.watermark.common/verticalalignment) value.

Parameters:

Parameter	Type	Description
value	int	The value to convert.

Returns: java.lang.String - The string representation of the [VerticalAlignment](../../com.groupdocs.watermark.common/verticalalignment) value.

parse(String value)

public static final int parse(String value)

Parses a string to a [VerticalAlignment](../../com.groupdocs.watermark.common/verticalalignment) enumeration value.

Parameters:

Parameter	Type	Description
value	java.lang.String	The string to parse.

Returns: int - The [VerticalAlignment](../../com.groupdocs.watermark.common/verticalalignment) enumeration value.

Java: IDocumentInfo

Mon, 01 Jan 0001 00:00:00 +0000

public interface IDocumentInfo

Defines the methods that are required for getting the basic document information.

Learn more

Get document info

The following example demonstrates how to retrieve the general document information using [IDocumentInfo](../../com.groupdocs.watermark.common/idocumentinfo).

Watermarker watermarker = new Watermarker(“D:\input.pdf”); IDocumentInfo docInfo = watermarker.getDocumentInfo(); System.out.println(“File type: " + docInfo.getFileType()); System.out.println(“Number of pages: " + docInfo.getPageCount()); System.out.println(“Document size: " + docInfo.getSize() + " bytes”); watermarker.close();

Methods

Method	Description
getFileType()	Gets the file format description.
getPageCount()	Gets the total page count.
getPages()	Gets the collection of document pages descriptions.
getSize()	Gets the document size in bytes.
isEncrypted()	Gets a value indicating whether the document is encrypted and requires a password to open.

getFileType()

public abstract FileType getFileType()

Gets the file format description.

Returns: FileType - The file format description.

getPageCount()

public abstract int getPageCount()

Gets the total page count.

Returns: int - The total page count.

getPages()

public abstract System.Collections.Generic.IGenericList<PageInfo> getPages()

Gets the collection of document pages descriptions.

Returns: com.aspose.ms.System.Collections.Generic.IGenericList<com.groupdocs.watermark.common.PageInfo> - The collection of document pages descriptions.

getSize()

public abstract long getSize()

Gets the document size in bytes.

Returns: long - The document size in bytes.

isEncrypted()

public abstract boolean isEncrypted()

Gets a value indicating whether the document is encrypted and requires a password to open.

Returns: boolean - True if the document is encrypted and requires a password to open; otherwise, false.