Groupdocs API References – GroupDocs.Watermark.Common

Net: Attachment

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

Attachment class

Represents a file attached to a document.

public abstract class Attachment

Properties

Name	Description
abstract Content { get; set; }	Gets or sets the attached file content.

Methods

Name	Description
CreateWatermarker()	Loads a content from the attached file.
CreateWatermarker(LoadOptions)	Loads a content from the attached file with the specified load options.
CreateWatermarker(LoadOptions, WatermarkerSettings)	Loads a content from the attached file with the specified load options and settings.
GetDocumentInfo()	Gets the information about a document stored in the attached file.

Remarks

Learn more

Net: AttachmentWatermarkableImage

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

AttachmentWatermarkableImage class

Represents an attached image inside a content of any supported type.

public class AttachmentWatermarkableImage : WatermarkableImage

Properties

Name	Description
Height { get; }	Gets the height of this `WatermarkableImage` in pixels.
Width { get; }	Gets the width of this `WatermarkableImage` in pixels.

Methods

Name	Description
Add(Watermark)	Adds a watermark to this `WatermarkableImage`. This method assumes that watermark offset and size are measured in pixels (if they are assigned).
FindImages()	Finds all images in the content. The search is conducted in the objects specified in `SearchableObjects`.
FindImages(ImageSearchCriteria)	Finds images according to the specified search criteria. The search is conducted in the objects specified in `SearchableObjects`.
GetBytes()	Gets the image as byte array.
Search()	Finds all possible watermarks in the content. The search is conducted in the objects specified in `SearchableObjects`.
Search(SearchCriteria)	Finds possible watermarks according to specified search criteria. The search is conducted in the objects specified in `SearchableObjects`.

Net: Dimension

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

Dimension enumeration

Represents dimensions of a 2d object.

public enum Dimension

Values

Name	Value	Description
Width	`0`	Object width.
Height	`1`	Object height.

Net: FileType

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

FileType class

Represents file type.

public sealed class FileType : IEquatable<FileType>

Properties

Name	Description
Extension { get; }	Gets the file name suffix (including the period “.”) e.g., “.doc”.
FileFormatName { get; }	Gets the file type name e.g., “Microsoft Word Document”.
FormatFamily { get; }	Gets the format family.

Methods

Name	Description
static FromExtension(string)	Maps the file extension to the file type.
Equals(FileType)	Determines whether the current `FileType` is the same as the specified `FileType` object.
override Equals(object)	Determines whether the current `FileType` is the same as the specified object.
override GetHashCode()	Returns a hash code for the current `FileType` object.
override ToString()	Returns a string that represents the current object.
static GetSupportedFileTypes()	Retrieves the supported file types.
operator ==	Determines whether two `FileType` objects are the same.
operator !=	Determines whether two `FileType` objects are not the same.

Fields

Name	Description
static readonly 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.
static readonly 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.
static readonly DOCM	DOCM files are Microsoft Word 2007 or higher generated documents with the ability to run macros. Learn more about this file format here.
static readonly 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.
static readonly 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.
static readonly DOTM	A file with DOTM extension represents template file created with Microsoft Word 2007 or higher. Learn more about this file format here.
static readonly 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.
static readonly EML	EML file format represents email messages saved using Outlook and other relevant applications. Learn more about this file format here.
static readonly 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.
static readonly FlatOpc	Office Open XML WordprocessingML stored in a flat XML file instead of a ZIP package (.xml). Learn more about this file format here.
static readonly 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.
static readonly 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.
static readonly 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.
static readonly GIF	A GIF or Graphical Interchange Format is a type of highly compressed image. Learn more about this file format here.
static readonly 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.
static readonly 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.
static readonly 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.
static readonly 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.
static readonly 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.
static readonly 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.
static readonly 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.
static readonly OFT	Files with .OFT extension represent message template files that are created using Microsoft Outlook. Learn more about this file format here.
static readonly OOXML	Office open xml file (.ooxml).
static readonly 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.
static readonly 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.
static readonly 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.
static readonly 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.
static readonly 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.
static readonly 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.
static readonly 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.
static readonly 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.
static readonly 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.
static readonly 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.
static readonly 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.
static readonly 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.
static readonly 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.
static readonly Unknown	Represents unknown file type.
static readonly 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.
static readonly VDX	Any drawing or chart created in Microsoft Visio, but saved in XML format have .VDX extension. Learn more about this file format here.
static readonly 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.
static readonly VSDM	Files with VSDM extension are drawing files created with Microsoft Visio application that supports macros. Learn more about this file format here.
static readonly VSDX	Files with .VSDX extension represent Microsoft Visio file format introduced from Microsoft Office 2013 onwards. Learn more about this file format here.
static readonly 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.
static readonly VSSM	Files with .VSSM extension are Microsoft Visio Stencil files that support provide support for macros. Learn more about this file format here.
static readonly VSSX	Files with .VSSX extension are drawing stencils created with Microsoft Visio 2013 and above. Learn more about this file format here.
static readonly 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.
static readonly VSTM	Files with VSTM extension are template files created with Microsoft Visio that support macros. Learn more about this file format here.
static readonly VSTX	Files with VSTX extensions are drawing template files created with Microsoft Visio 2013 and above. Learn more about this file format here.
static readonly 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.
static readonly 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.
static readonly 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.
static readonly 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.
static readonly 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.
static readonly XLSM	Files with XLSM extension is a type of Spreasheet files that support Macros. Learn more about this file format here.
static readonly 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.
static readonly 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.
static readonly 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.
static readonly 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.

Remarks

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

Net: FormatFamily

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

FormatFamily enumeration

Enumeration of supported format families.

public enum FormatFamily

Values

Name	Value	Description
Unknown	`0`	Unknown format family.
Diagram	`1`	Diagram format family.
Email	`2`	Email format family.
Image	`3`	Image format family.
MultiframeImage	`4`	Multi frame image format family.
Pdf	`5`	PDF format family.
Presentation	`6`	Presentation format family.
Spreadsheet	`7`	Spreadsheet format family.
WordProcessing	`8`	Word processing format family.

Remarks

Learn more

Net: HorizontalAlignment

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

HorizontalAlignment enumeration

Enumeration of possible horizontal alignment values.

public enum HorizontalAlignment

Values

Name	Value	Description
None	`0`	No alignment (use specified position).
Left	`1`	Align to left.
Center	`2`	Center alignment.
Right	`3`	Align to right.

Remarks

Learn more

Net: IDocumentInfo

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

IDocumentInfo interface

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

public interface IDocumentInfo

Properties

Name	Description
FileType { get; }	Gets the file format description.
IsEncrypted { get; }	Gets a value indicating whether the document is encrypted and requires a password to open.
PageCount { get; }	Gets the total page count.
Pages { get; }	Gets the collection of document pages descriptions.
Size { get; }	Gets the document size in bytes.

Remarks

Learn more

Get document info

Examples

The following example demonstrates how to retrieve the general document information using IDocumentInfo.

using (Watermarker watermarker = new Watermarker("D:\\input.pdf"))
{
    IDocumentInfo docInfo = watermarker.GetDocumentInfo();
    Console.WriteLine("Document size: {0}", docInfo.Size);
    Console.WriteLine("Document format: {0}", docInfo.FileType.FileFormat);
    Console.WriteLine("Document contains {0} pages", docInfo.PageCount);
}

Net: PageInfo

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

PageInfo class

Represents a document page description.

public sealed class PageInfo

Properties

Name	Description
Height { get; }	Gets the document page height.
PageNumber { get; }	Gets the document page number.
Width { get; }	Gets the document page width.

Net: ReadOnlyListBaseT

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

ReadOnlyListBase<T> class

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

public abstract class ReadOnlyListBase<T> : IList, IList<T>

Parameter	Description
T	The type of the element.

Properties

Name	Description
virtual Count { get; }	Gets the number of elements contained in the collection.
virtual IsReadOnly { get; }	Gets a value indicating whether the collection is read-only.
virtual Item { get; }	Gets the element at the specified index in the collection.

Methods

Name	Description
virtual Contains(T)	Determines whether the collection contains a specific item.
virtual GetEnumerator()	Returns an enumerator that iterates through a collection.
virtual IndexOf(T)	Determines the index of a specific item in the collection.

Net: RemoveOnlyListBaseT

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

RemoveOnlyListBase<T> class

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

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

Parameter	Description
T	The type of the element.

Properties

Name	Description
virtual Count { get; }	Gets the number of elements contained in the collection.
override IsReadOnly { get; }	Gets a value indicating whether the collection is read-only.
virtual Item { get; }	Gets the element at the specified index in the collection.

Methods

Name	Description
Clear()	Removes all items from the collection.
virtual Contains(T)
virtual GetEnumerator()
virtual IndexOf(T)
Remove(T)	Removes the first occurrence of a specific object from the collection.
RemoveAt(int)	Removes the item at the specified index.

Net: VerticalAlignment

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

VerticalAlignment enumeration

Enumeration of possible vertical alignment values.

public enum VerticalAlignment

Values

Name	Value	Description
None	`0`	No alignment (use specified position).
Top	`1`	Align to top.
Center	`2`	Center alignment.
Bottom	`3`	Align to bottom.

Remarks

Learn more

Groupdocs API References – GroupDocs.Watermark.Common

Net: Attachment

Attachment class

Properties

Methods

Remarks

See Also

Net: AttachmentWatermarkableImage

AttachmentWatermarkableImage class

Properties

Methods

See Also

Net: Dimension

Dimension enumeration

Values

See Also

Net: FileType

FileType class

Properties

Methods

Fields

Remarks

See Also

Net: FormatFamily

FormatFamily enumeration

Values

Remarks

See Also

Net: HorizontalAlignment

HorizontalAlignment enumeration

Values

Remarks

See Also

Net: IDocumentInfo

IDocumentInfo interface

Properties

Remarks

Examples

See Also

Net: PageInfo

PageInfo class

Properties

See Also

Net: ReadOnlyListBaseT

ReadOnlyListBase<T> class

Properties

Methods

See Also

Net: RemoveOnlyListBaseT

RemoveOnlyListBase<T> class

Properties

Methods

See Also

Net: VerticalAlignment

VerticalAlignment enumeration

Values

Remarks

See Also