Groupdocs API References – com.groupdocs.watermark.search

Java: AndSearchCriteria

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

Inheritance: java.lang.Object, com.groupdocs.watermark.search.SearchCriteria

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

public class AndSearchCriteria extends SearchCriteria implements IBinaryOperation

Represents AND composite search criteria.

Methods

Method	Description
getRight()	Gets the right search criteria.
getLeft()	Gets the left search criteria.
isSatisfiedBy(PossibleWatermark candidate)
accept(ICriteriaVisitor visitor)

getRight()

public final SearchCriteria getRight()

Gets the right search criteria.

Returns: SearchCriteria - The right search criteria.

getLeft()

public final SearchCriteria getLeft()

Gets the left search criteria.

Returns: SearchCriteria - The left search criteria.

isSatisfiedBy(PossibleWatermark candidate)

public boolean isSatisfiedBy(PossibleWatermark candidate)

Parameters:

Parameter	Type	Description
candidate	PossibleWatermark

Returns: boolean

accept(ICriteriaVisitor visitor)

public void accept(ICriteriaVisitor visitor)

Parameters:

Parameter	Type	Description
visitor	ICriteriaVisitor

Java: AttachedImagePossibleWatermark

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

Inheritance: java.lang.Object, com.groupdocs.watermark.search.PossibleWatermark

public abstract class AttachedImagePossibleWatermark<T> extends PossibleWatermark

Represents attached image watermark in a content of any supported format.

T : The type of the attachment.

Methods

Method	Description
getParent()	Gets the parent of this `[AttachedImagePossibleWatermark](../../com.groupdocs.watermark.search/attachedimagepossiblewatermark)`.
getWidth()	Gets the width of this `[AttachedImagePossibleWatermark](../../com.groupdocs.watermark.search/attachedimagepossiblewatermark)`.
getHeight()	Gets the height of this `[AttachedImagePossibleWatermark](../../com.groupdocs.watermark.search/attachedimagepossiblewatermark)`.
getX()	Gets the x-coordinate of this `[AttachedImagePossibleWatermark](../../com.groupdocs.watermark.search/attachedimagepossiblewatermark)`.
getY()	Gets the y-coordinate of this `[AttachedImagePossibleWatermark](../../com.groupdocs.watermark.search/attachedimagepossiblewatermark)`.
getRotateAngle()	Gets the rotate angle of this `[AttachedImagePossibleWatermark](../../com.groupdocs.watermark.search/attachedimagepossiblewatermark)` in degrees.
getUnitOfMeasurement()	Gets the unit of measurement `[UnitOfMeasurement](../../com.groupdocs.watermark.common/unitofmeasurement)` of this `[AttachedImagePossibleWatermark](../../com.groupdocs.watermark.search/attachedimagepossiblewatermark)`.
getImageInternally()
remove()

getParent()

public ContentPart getParent()

Gets the parent of this [AttachedImagePossibleWatermark](../../com.groupdocs.watermark.search/attachedimagepossiblewatermark).

Returns: ContentPart - The parent of this [AttachedImagePossibleWatermark](../../com.groupdocs.watermark.search/attachedimagepossiblewatermark).

getWidth()

public double getWidth()

Gets the width of this [AttachedImagePossibleWatermark](../../com.groupdocs.watermark.search/attachedimagepossiblewatermark).

Returns: double - The width of this [AttachedImagePossibleWatermark](../../com.groupdocs.watermark.search/attachedimagepossiblewatermark).

getHeight()

public double getHeight()

Gets the height of this [AttachedImagePossibleWatermark](../../com.groupdocs.watermark.search/attachedimagepossiblewatermark).

Returns: double - The height of this [AttachedImagePossibleWatermark](../../com.groupdocs.watermark.search/attachedimagepossiblewatermark).

getX()

public double getX()

Gets the x-coordinate of this [AttachedImagePossibleWatermark](../../com.groupdocs.watermark.search/attachedimagepossiblewatermark).

Returns: double - The x-coordinate of this [AttachedImagePossibleWatermark](../../com.groupdocs.watermark.search/attachedimagepossiblewatermark).

getY()

public double getY()

Gets the y-coordinate of this [AttachedImagePossibleWatermark](../../com.groupdocs.watermark.search/attachedimagepossiblewatermark).

Returns: double - The y-coordinate of this [AttachedImagePossibleWatermark](../../com.groupdocs.watermark.search/attachedimagepossiblewatermark).

getRotateAngle()

public double getRotateAngle()

Gets the rotate angle of this [AttachedImagePossibleWatermark](../../com.groupdocs.watermark.search/attachedimagepossiblewatermark) in degrees.

Returns: double - The rotate angle of this [AttachedImagePossibleWatermark](../../com.groupdocs.watermark.search/attachedimagepossiblewatermark).

getUnitOfMeasurement()

public int getUnitOfMeasurement()

Gets the unit of measurement [UnitOfMeasurement](../../com.groupdocs.watermark.common/unitofmeasurement) of this [AttachedImagePossibleWatermark](../../com.groupdocs.watermark.search/attachedimagepossiblewatermark).

Returns: int - The unit of measurement [UnitOfMeasurement](../../com.groupdocs.watermark.common/unitofmeasurement) of this [AttachedImagePossibleWatermark](../../com.groupdocs.watermark.search/attachedimagepossiblewatermark).

getImageInternally()

public WatermarkableImage getImageInternally()

Returns: WatermarkableImage

remove()

public void remove()

Java: ColorRange

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

Inheritance: java.lang.Object

public class ColorRange

Represents a range of colors. Specifies ranges using HSB representation of RGB color.

Constructors

Constructor	Description
ColorRange()	Initializes a new instance of the `[ColorRange](../../com.groupdocs.watermark.search/colorrange)` class.
ColorRange(Color exactColor)	Initializes a new instance of the `[ColorRange](../../com.groupdocs.watermark.search/colorrange)` class with a specified exact color.

Methods

Method	Description
getMinHue()	Gets the starting hue value, in degrees.
setMinHue(float value)	Sets the starting hue value, in degrees.
getMaxHue()	Gets the ending hue value, in degrees.
setMaxHue(float value)	Sets the ending hue value, in degrees.
getMinSaturation()	Gets the starting saturation value.
setMinSaturation(float value)	Sets the starting saturation value.
getMaxSaturation()	Gets the ending saturation value.
setMaxSaturation(float value)	Sets the ending saturation value.
getMinBrightness()	Gets the starting brightness value.
setMinBrightness(float value)	Sets the starting brightness value.
getMaxBrightness()	Gets the ending brightness value.
setMaxBrightness(float value)	Sets the ending brightness value.
isEmpty()	Gets a value indicating whether only the empty color is in range.
setEmpty(boolean value)	Sets a value indicating whether only the empty color is in range.

ColorRange()

public ColorRange()

Initializes a new instance of the [ColorRange](../../com.groupdocs.watermark.search/colorrange) class.

ColorRange(Color exactColor)

public ColorRange(Color exactColor)

Initializes a new instance of the [ColorRange](../../com.groupdocs.watermark.search/colorrange) class with a specified exact color.

Parameters:

Parameter	Type	Description
exactColor	Color	The exact color from which the range is created.

getMinHue()

public final float getMinHue()

Gets the starting hue value, in degrees.

Returns: float - The starting hue value, in degrees.

setMinHue(float value)

public final void setMinHue(float value)

Sets the starting hue value, in degrees.

Parameters:

Parameter	Type	Description
value	float	The starting hue value, in degrees.

getMaxHue()

public final float getMaxHue()

Gets the ending hue value, in degrees.

Returns: float - The ending hue value, in degrees.

setMaxHue(float value)

public final void setMaxHue(float value)

Sets the ending hue value, in degrees.

Parameters:

Parameter	Type	Description
value	float	The ending hue value, in degrees.

getMinSaturation()

public final float getMinSaturation()

Gets the starting saturation value.

Returns: float - The saturation ranges from 0.0 through 1.0, where 0.0 is grayscale and 1.0 is the most saturated.

setMinSaturation(float value)

public final void setMinSaturation(float value)

Sets the starting saturation value.

Parameters:

Parameter	Type	Description
value	float	The saturation ranges from 0.0 through 1.0, where 0.0 is grayscale and 1.0 is the most saturated.

getMaxSaturation()

public final float getMaxSaturation()

Gets the ending saturation value.

Returns: float - The saturation ranges from 0.0 through 1.0, where 0.0 is grayscale and 1.0 is the most saturated.

setMaxSaturation(float value)

public final void setMaxSaturation(float value)

Sets the ending saturation value.

Parameters:

Parameter	Type	Description
value	float	The saturation ranges from 0.0 through 1.0, where 0.0 is grayscale and 1.0 is the most saturated.

getMinBrightness()

public final float getMinBrightness()

Gets the starting brightness value.

Returns: float - The brightness ranges from 0.0 through 1.0, where 0.0 represents black and 1.0 represents white.

setMinBrightness(float value)

public final void setMinBrightness(float value)

Sets the starting brightness value.

Parameters:

Parameter	Type	Description
value	float	The brightness ranges from 0.0 through 1.0, where 0.0 represents black and 1.0 represents white.

getMaxBrightness()

public final float getMaxBrightness()

Gets the ending brightness value.

Returns: float - The brightness ranges from 0.0 through 1.0, where 0.0 represents black and 1.0 represents white.

setMaxBrightness(float value)

public final void setMaxBrightness(float value)

Sets the ending brightness value.

Parameters:

Parameter	Type	Description
value	float	The brightness ranges from 0.0 through 1.0, where 0.0 represents black and 1.0 represents white.

isEmpty()

public final boolean isEmpty()

Gets a value indicating whether only the empty color is in range.

Returns: boolean - True if only the empty color is in range (HSB ranges are ignored); otherwise, false.

setEmpty(boolean value)

public final void setEmpty(boolean value)

Sets a value indicating whether only the empty color is in range.

Parameters:

Parameter	Type	Description
value	boolean	True if only the empty color is in range (HSB ranges are ignored); otherwise, false.

Java: DiagramCommentPossibleWatermark

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

Inheritance: java.lang.Object, com.groupdocs.watermark.search.PossibleWatermark

public class DiagramCommentPossibleWatermark extends PossibleWatermark

Represents possible watermark in a Visio document comment.

Constructors

Constructor	Description
DiagramCommentPossibleWatermark(Annotation annotation, AnnotationCollection annotationCollection, DiagramPage page)

Methods

Method	Description
getParent()	Gets the parent of this `[DiagramCommentPossibleWatermark](../../com.groupdocs.watermark.search/diagramcommentpossiblewatermark)`.
getWidth()	Gets the width of this `[DiagramCommentPossibleWatermark](../../com.groupdocs.watermark.search/diagramcommentpossiblewatermark)` in points.
getHeight()	Gets the height of this `[DiagramCommentPossibleWatermark](../../com.groupdocs.watermark.search/diagramcommentpossiblewatermark)` in points.
getX()	Gets the horizontal offset of this `[DiagramCommentPossibleWatermark](../../com.groupdocs.watermark.search/diagramcommentpossiblewatermark)` from page left border in points.
getY()	Gets the vertical offset of this `[DiagramCommentPossibleWatermark](../../com.groupdocs.watermark.search/diagramcommentpossiblewatermark)` from page bottom border in points.
getRotateAngle()	Gets the rotate angle of this `[DiagramCommentPossibleWatermark](../../com.groupdocs.watermark.search/diagramcommentpossiblewatermark)` in degrees.
getText()	Gets the text of this `[DiagramCommentPossibleWatermark](../../com.groupdocs.watermark.search/diagramcommentpossiblewatermark)`.
setText(String value)	Sets the text of this `[DiagramCommentPossibleWatermark](../../com.groupdocs.watermark.search/diagramcommentpossiblewatermark)`.
getUnitOfMeasurement()	Gets the `[UnitOfMeasurement](../../com.groupdocs.watermark.common/unitofmeasurement)` of this `[DiagramCommentPossibleWatermark](../../com.groupdocs.watermark.search/diagramcommentpossiblewatermark)`.
remove()

DiagramCommentPossibleWatermark(Annotation annotation, AnnotationCollection annotationCollection, DiagramPage page)

public DiagramCommentPossibleWatermark(Annotation annotation, AnnotationCollection annotationCollection, DiagramPage page)

Parameters:

Parameter	Type	Description
annotation	com.aspose.diagram.Annotation
annotationCollection	com.aspose.diagram.AnnotationCollection
page	DiagramPage

getParent()

public ContentPart getParent()

Gets the parent of this [DiagramCommentPossibleWatermark](../../com.groupdocs.watermark.search/diagramcommentpossiblewatermark).

Returns: ContentPart - The parent of this [DiagramCommentPossibleWatermark](../../com.groupdocs.watermark.search/diagramcommentpossiblewatermark).

getWidth()

public double getWidth()

Gets the width of this [DiagramCommentPossibleWatermark](../../com.groupdocs.watermark.search/diagramcommentpossiblewatermark) in points.

Returns: double - The value is always 0 for this type of possible watermark.

getHeight()

public double getHeight()

Gets the height of this [DiagramCommentPossibleWatermark](../../com.groupdocs.watermark.search/diagramcommentpossiblewatermark) in points.

Returns: double - The value is always 0 for this type of possible watermark.

getX()

public double getX()

Gets the horizontal offset of this [DiagramCommentPossibleWatermark](../../com.groupdocs.watermark.search/diagramcommentpossiblewatermark) from page left border in points.

Returns: double - The x-coordinate of this [DiagramCommentPossibleWatermark](../../com.groupdocs.watermark.search/diagramcommentpossiblewatermark).

getY()

public double getY()

Gets the vertical offset of this [DiagramCommentPossibleWatermark](../../com.groupdocs.watermark.search/diagramcommentpossiblewatermark) from page bottom border in points.

Returns: double - The y-coordinate of this [DiagramCommentPossibleWatermark](../../com.groupdocs.watermark.search/diagramcommentpossiblewatermark).

getRotateAngle()

public double getRotateAngle()

Gets the rotate angle of this [DiagramCommentPossibleWatermark](../../com.groupdocs.watermark.search/diagramcommentpossiblewatermark) in degrees.

Returns: double - The value is always 0 for this type of possible watermark.

getText()

public String getText()

Gets the text of this [DiagramCommentPossibleWatermark](../../com.groupdocs.watermark.search/diagramcommentpossiblewatermark).

Returns: java.lang.String - The text of this [DiagramCommentPossibleWatermark](../../com.groupdocs.watermark.search/diagramcommentpossiblewatermark).

setText(String value)

public void setText(String value)

Sets the text of this [DiagramCommentPossibleWatermark](../../com.groupdocs.watermark.search/diagramcommentpossiblewatermark).

Parameters:

Parameter	Type	Description
value	java.lang.String	The text of this `[DiagramCommentPossibleWatermark](../../com.groupdocs.watermark.search/diagramcommentpossiblewatermark)`.

getUnitOfMeasurement()

public int getUnitOfMeasurement()

Gets the [UnitOfMeasurement](../../com.groupdocs.watermark.common/unitofmeasurement) of this [DiagramCommentPossibleWatermark](../../com.groupdocs.watermark.search/diagramcommentpossiblewatermark).

Returns: int - The [UnitOfMeasurement](../../com.groupdocs.watermark.common/unitofmeasurement) of this [DiagramCommentPossibleWatermark](../../com.groupdocs.watermark.search/diagramcommentpossiblewatermark).

remove()

public void remove()

Java: DiagramHeaderFooterPossibleWatermark

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

Inheritance: java.lang.Object, com.groupdocs.watermark.search.PossibleWatermark

public class DiagramHeaderFooterPossibleWatermark extends PossibleWatermark

Represents possible watermark in a Visio document header/footer.

Constructors

Constructor	Description
DiagramHeaderFooterPossibleWatermark(DiagramContent content, int headerFooterType)

Methods

Method	Description
getParent()	Gets the parent of this `[DiagramHeaderFooterPossibleWatermark](../../com.groupdocs.watermark.search/diagramheaderfooterpossiblewatermark)`.
getWidth()	Gets the width of this `[DiagramHeaderFooterPossibleWatermark](../../com.groupdocs.watermark.search/diagramheaderfooterpossiblewatermark)` in points.
getHeight()	Gets the height of this `[DiagramHeaderFooterPossibleWatermark](../../com.groupdocs.watermark.search/diagramheaderfooterpossiblewatermark)` in points.
getX()	Gets the horizontal offset of this `[DiagramHeaderFooterPossibleWatermark](../../com.groupdocs.watermark.search/diagramheaderfooterpossiblewatermark)` from page left border in points.
getY()	Gets the vertical offset of this `[DiagramHeaderFooterPossibleWatermark](../../com.groupdocs.watermark.search/diagramheaderfooterpossiblewatermark)` from page bottom border in points.
getRotateAngle()	Gets the rotate angle of this `[DiagramHeaderFooterPossibleWatermark](../../com.groupdocs.watermark.search/diagramheaderfooterpossiblewatermark)` in degrees.
getText()	Gets the text of this `[DiagramHeaderFooterPossibleWatermark](../../com.groupdocs.watermark.search/diagramheaderfooterpossiblewatermark)`.
setText(String value)	Sets the text of this `[DiagramHeaderFooterPossibleWatermark](../../com.groupdocs.watermark.search/diagramheaderfooterpossiblewatermark)`.
getUnitOfMeasurement()	Gets the `[UnitOfMeasurement](../../com.groupdocs.watermark.common/unitofmeasurement)` of this `[DiagramHeaderFooterPossibleWatermark](../../com.groupdocs.watermark.search/diagramheaderfooterpossiblewatermark)`.
remove()

DiagramHeaderFooterPossibleWatermark(DiagramContent content, int headerFooterType)

public DiagramHeaderFooterPossibleWatermark(DiagramContent content, int headerFooterType)

Parameters:

Parameter	Type	Description
content	DiagramContent
headerFooterType	int

getParent()

public ContentPart getParent()

Gets the parent of this [DiagramHeaderFooterPossibleWatermark](../../com.groupdocs.watermark.search/diagramheaderfooterpossiblewatermark).

Returns: ContentPart - The parent of this [DiagramHeaderFooterPossibleWatermark](../../com.groupdocs.watermark.search/diagramheaderfooterpossiblewatermark).

getWidth()

public double getWidth()

Gets the width of this [DiagramHeaderFooterPossibleWatermark](../../com.groupdocs.watermark.search/diagramheaderfooterpossiblewatermark) in points.

Returns: double - The value is always 0 for this type of possible watermark.

getHeight()

public double getHeight()

Gets the height of this [DiagramHeaderFooterPossibleWatermark](../../com.groupdocs.watermark.search/diagramheaderfooterpossiblewatermark) in points.

Returns: double - The value is always 0 for this type of possible watermark.

getX()

public double getX()

Gets the horizontal offset of this [DiagramHeaderFooterPossibleWatermark](../../com.groupdocs.watermark.search/diagramheaderfooterpossiblewatermark) from page left border in points.

Returns: double - The value is always 0 for this type of possible watermark.

getY()

public double getY()

Gets the vertical offset of this [DiagramHeaderFooterPossibleWatermark](../../com.groupdocs.watermark.search/diagramheaderfooterpossiblewatermark) from page bottom border in points.

Returns: double - The value is always 0 for this type of possible watermark.

getRotateAngle()

public double getRotateAngle()

Gets the rotate angle of this [DiagramHeaderFooterPossibleWatermark](../../com.groupdocs.watermark.search/diagramheaderfooterpossiblewatermark) in degrees.

Returns: double - The value is always 0 for this type of possible watermark.

getText()

public String getText()

Gets the text of this [DiagramHeaderFooterPossibleWatermark](../../com.groupdocs.watermark.search/diagramheaderfooterpossiblewatermark).

Returns: java.lang.String - The text of this [DiagramHeaderFooterPossibleWatermark](../../com.groupdocs.watermark.search/diagramheaderfooterpossiblewatermark).

setText(String value)

public void setText(String value)

Sets the text of this [DiagramHeaderFooterPossibleWatermark](../../com.groupdocs.watermark.search/diagramheaderfooterpossiblewatermark).

Parameters:

Parameter	Type	Description
value	java.lang.String	The text of this `[DiagramHeaderFooterPossibleWatermark](../../com.groupdocs.watermark.search/diagramheaderfooterpossiblewatermark)`.

getUnitOfMeasurement()

public int getUnitOfMeasurement()

Gets the [UnitOfMeasurement](../../com.groupdocs.watermark.common/unitofmeasurement) of this [DiagramHeaderFooterPossibleWatermark](../../com.groupdocs.watermark.search/diagramheaderfooterpossiblewatermark).

Returns: int - The [UnitOfMeasurement](../../com.groupdocs.watermark.common/unitofmeasurement) of this [DiagramHeaderFooterPossibleWatermark](../../com.groupdocs.watermark.search/diagramheaderfooterpossiblewatermark).

remove()

public void remove()

Java: DiagramHyperlinkPossibleWatermark

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

Inheritance: java.lang.Object, com.groupdocs.watermark.search.PossibleWatermark, com.groupdocs.watermark.search.HyperlinkPossibleWatermark

public class DiagramHyperlinkPossibleWatermark extends HyperlinkPossibleWatermark

Represents possible hyperlink watermark in a Visio document.

Constructors

Constructor	Description
DiagramHyperlinkPossibleWatermark(DiagramShapePossibleWatermark parentWatermark, DiagramHyperlink hyperlink, DiagramHyperlinkCollection collection)

Methods

Method	Description
getText()	Gets the url of this `[DiagramHyperlinkPossibleWatermark](../../com.groupdocs.watermark.search/diagramhyperlinkpossiblewatermark)`.
setText(String value)
remove()

DiagramHyperlinkPossibleWatermark(DiagramShapePossibleWatermark parentWatermark, DiagramHyperlink hyperlink, DiagramHyperlinkCollection collection)

public DiagramHyperlinkPossibleWatermark(DiagramShapePossibleWatermark parentWatermark, DiagramHyperlink hyperlink, DiagramHyperlinkCollection collection)

Parameters:

Parameter	Type	Description
parentWatermark	DiagramShapePossibleWatermark
hyperlink	DiagramHyperlink
collection	DiagramHyperlinkCollection

getText()

public String getText()

Gets the url of this [DiagramHyperlinkPossibleWatermark](../../com.groupdocs.watermark.search/diagramhyperlinkpossiblewatermark).

Returns: java.lang.String - The url of this [DiagramHyperlinkPossibleWatermark](../../com.groupdocs.watermark.search/diagramhyperlinkpossiblewatermark).

setText(String value)

public void setText(String value)

Sets the url of this [HyperlinkPossibleWatermark](../../com.groupdocs.watermark.search/hyperlinkpossiblewatermark).

Parameters:

Parameter	Type	Description
value	java.lang.String

remove()

public void remove()

Java: DiagramSearchableObjects

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

Inheritance: java.lang.Object

public final class DiagramSearchableObjects

Specifies flags representing Visio document objects that are to be included in a watermark search.

Fields

Field	Description
None	Specifies no search objects.
Shapes	Search in shapes.
Comments	Search in comments.
HeadersFooters	Search in headers and footers.
Hyperlinks	Search in hyperlinks.
All	Search in all content objects.

Methods

Method	Description
getValues()	Gets an array of all values of `[DiagramSearchableObjects](../../com.groupdocs.watermark.search/diagramsearchableobjects)` enumeration.

None

public static final int None

Specifies no search objects.

Shapes

public static final int Shapes

Search in shapes.

Comments

public static final int Comments

Search in comments.

HeadersFooters

public static final int HeadersFooters

Search in headers and footers.

Hyperlinks

public static final int Hyperlinks

Search in hyperlinks.

All

public static final int All

Search in all content objects.

getValues()

public static final int[] getValues()

Gets an array of all values of [DiagramSearchableObjects](../../com.groupdocs.watermark.search/diagramsearchableobjects) enumeration.

Returns: int[] - The array of all values of [DiagramSearchableObjects](../../com.groupdocs.watermark.search/diagramsearchableobjects) enumeration.

Java: DiagramShapePossibleWatermark

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

Inheritance: java.lang.Object, com.groupdocs.watermark.search.PossibleWatermark, com.groupdocs.watermark.search.TwoDObjectPossibleWatermark, com.groupdocs.watermark.search.ShapePossibleWatermark

public class DiagramShapePossibleWatermark extends ShapePossibleWatermark<DiagramShape>

Represents possible shape watermark in a Visio document.

Constructors

Constructor	Description
DiagramShapePossibleWatermark(DiagramShape shape, DiagramShapeCollection shapeCollection)

Methods

Method	Description
getParent()	Gets the parent of this `[DiagramShapePossibleWatermark](../../com.groupdocs.watermark.search/diagramshapepossiblewatermark)`.

DiagramShapePossibleWatermark(DiagramShape shape, DiagramShapeCollection shapeCollection)

public DiagramShapePossibleWatermark(DiagramShape shape, DiagramShapeCollection shapeCollection)

Parameters:

Parameter	Type	Description
shape	DiagramShape
shapeCollection	DiagramShapeCollection

getParent()

public ContentPart getParent()

Gets the parent of this [DiagramShapePossibleWatermark](../../com.groupdocs.watermark.search/diagramshapepossiblewatermark).

Returns: ContentPart - The parent of this [DiagramShapePossibleWatermark](../../com.groupdocs.watermark.search/diagramshapepossiblewatermark).

Java: EmailAttachedImagePossibleWatermark

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

Inheritance: java.lang.Object, com.groupdocs.watermark.search.PossibleWatermark, com.groupdocs.watermark.search.AttachedImagePossibleWatermark

public class EmailAttachedImagePossibleWatermark extends AttachedImagePossibleWatermark<EmailAttachment>

Represents possible image watermark in email message attachment.

Constructors

Constructor	Description
EmailAttachedImagePossibleWatermark(EmailContent content, EmailAttachment attachment)

EmailAttachedImagePossibleWatermark(EmailContent content, EmailAttachment attachment)

public EmailAttachedImagePossibleWatermark(EmailContent content, EmailAttachment attachment)

Parameters:

Parameter	Type	Description
content	EmailContent
attachment	EmailAttachment

Java: EmailBodyTextPossibleWatermark

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

Inheritance: java.lang.Object, com.groupdocs.watermark.search.PossibleWatermark, com.groupdocs.watermark.search.EmailTextPossibleWatermark

public class EmailBodyTextPossibleWatermark extends EmailTextPossibleWatermark

Represents possible watermark in email message body.

Constructors

Constructor	Description
EmailBodyTextPossibleWatermark(EmailContent content, System.Text.RegularExpressions.Match match)

EmailBodyTextPossibleWatermark(EmailContent content, System.Text.RegularExpressions.Match match)

public EmailBodyTextPossibleWatermark(EmailContent content, System.Text.RegularExpressions.Match match)

Parameters:

Parameter	Type	Description
content	EmailContent
match	com.aspose.ms.System.Text.RegularExpressions.Match

Java: EmailEmbeddedImagePossibleWatermark

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

Inheritance: java.lang.Object, com.groupdocs.watermark.search.PossibleWatermark, com.groupdocs.watermark.search.AttachedImagePossibleWatermark

public class EmailEmbeddedImagePossibleWatermark extends AttachedImagePossibleWatermark<EmailEmbeddedObject>

Represents possible image watermark embedded to email message body.

Constructors

Constructor	Description
EmailEmbeddedImagePossibleWatermark(EmailContent content, EmailEmbeddedObject embeddedObject)

EmailEmbeddedImagePossibleWatermark(EmailContent content, EmailEmbeddedObject embeddedObject)

public EmailEmbeddedImagePossibleWatermark(EmailContent content, EmailEmbeddedObject embeddedObject)

Parameters:

Parameter	Type	Description
content	EmailContent
embeddedObject	EmailEmbeddedObject

Java: EmailHtmlBodyTextPossibleWatermark

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

Inheritance: java.lang.Object, com.groupdocs.watermark.search.PossibleWatermark, com.groupdocs.watermark.search.EmailTextPossibleWatermark

public class EmailHtmlBodyTextPossibleWatermark extends EmailTextPossibleWatermark

Represents possible watermark in email message html body.

Constructors

Constructor	Description
EmailHtmlBodyTextPossibleWatermark(EmailContent content, System.Text.RegularExpressions.Match match)

EmailHtmlBodyTextPossibleWatermark(EmailContent content, System.Text.RegularExpressions.Match match)

public EmailHtmlBodyTextPossibleWatermark(EmailContent content, System.Text.RegularExpressions.Match match)

Parameters:

Parameter	Type	Description
content	EmailContent
match	com.aspose.ms.System.Text.RegularExpressions.Match

Java: EmailSearchableObjects

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

Inheritance: java.lang.Object

public final class EmailSearchableObjects

Specifies flags representing email message objects that are to be included in a watermark search.

Fields

Field	Description
None	Specifies no search objects.
Subject	Search in message subject.
PlainTextBody	Search in message plain text body.
HtmlBody	Search in message html body.
AttachedImages	Search in attached images.
EmbeddedImages	Search in embedded images.
All	Search in all email objects.

Methods

Method	Description
getValues()	Gets an array of all values of `[EmailSearchableObjects](../../com.groupdocs.watermark.search/emailsearchableobjects)` enumeration.

None

public static final int None

Specifies no search objects.

Subject

public static final int Subject

Search in message subject.

PlainTextBody

public static final int PlainTextBody

Search in message plain text body.

HtmlBody

public static final int HtmlBody

Search in message html body.

AttachedImages

public static final int AttachedImages

Search in attached images.

EmbeddedImages

public static final int EmbeddedImages

Search in embedded images.

All

public static final int All

Search in all email objects.

getValues()

public static final int[] getValues()

Gets an array of all values of [EmailSearchableObjects](../../com.groupdocs.watermark.search/emailsearchableobjects) enumeration.

Returns: int[] - The array of all values of [EmailSearchableObjects](../../com.groupdocs.watermark.search/emailsearchableobjects) enumeration.

Java: EmailSubjectTextPossibleWatermark

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

Inheritance: java.lang.Object, com.groupdocs.watermark.search.PossibleWatermark, com.groupdocs.watermark.search.EmailTextPossibleWatermark

public class EmailSubjectTextPossibleWatermark extends EmailTextPossibleWatermark

Represents possible watermark in email message subject.

Constructors

Constructor	Description
EmailSubjectTextPossibleWatermark(EmailContent content, System.Text.RegularExpressions.Match match)

EmailSubjectTextPossibleWatermark(EmailContent content, System.Text.RegularExpressions.Match match)

public EmailSubjectTextPossibleWatermark(EmailContent content, System.Text.RegularExpressions.Match match)

Parameters:

Parameter	Type	Description
content	EmailContent
match	com.aspose.ms.System.Text.RegularExpressions.Match

Java: EmailTextPossibleWatermark

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

Inheritance: java.lang.Object, com.groupdocs.watermark.search.PossibleWatermark

public abstract class EmailTextPossibleWatermark extends PossibleWatermark

Represents possible watermark in email message text fields.

Methods

Method	Description
getParent()	Gets the parent of this .
getText()	Gets the text of this `[EmailTextPossibleWatermark](../../com.groupdocs.watermark.search/emailtextpossiblewatermark)`.
setText(String value)	Sets the text of this `[EmailTextPossibleWatermark](../../com.groupdocs.watermark.search/emailtextpossiblewatermark)`.
remove()

getParent()

public ContentPart getParent()

Gets the parent of this .

Returns: ContentPart - The parent of this .

getText()

public String getText()

Gets the text of this [EmailTextPossibleWatermark](../../com.groupdocs.watermark.search/emailtextpossiblewatermark).

Returns: java.lang.String - The text of this [EmailTextPossibleWatermark](../../com.groupdocs.watermark.search/emailtextpossiblewatermark).

setText(String value)

public void setText(String value)

Sets the text of this [EmailTextPossibleWatermark](../../com.groupdocs.watermark.search/emailtextpossiblewatermark).

Parameters:

Parameter	Type	Description
value	java.lang.String	The text of this `[EmailTextPossibleWatermark](../../com.groupdocs.watermark.search/emailtextpossiblewatermark)`.

remove()

public void remove()

Java: FloatingAttachedImagePossibleWatermark

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

Inheritance: java.lang.Object, com.groupdocs.watermark.search.PossibleWatermark, com.groupdocs.watermark.search.AttachedImagePossibleWatermark

public class FloatingAttachedImagePossibleWatermark<T> extends AttachedImagePossibleWatermark<T>

Represents attached image watermark in a content of any supported format.

T : The type of the attachment.

Methods

Method	Description
getParent()	Gets the parent of this `[FloatingAttachedImagePossibleWatermark](../../com.groupdocs.watermark.search/floatingattachedimagepossiblewatermark)`.
getWidth()	Gets the width of this `[FloatingAttachedImagePossibleWatermark](../../com.groupdocs.watermark.search/floatingattachedimagepossiblewatermark)`.
getHeight()	Gets the height of this `[FloatingAttachedImagePossibleWatermark](../../com.groupdocs.watermark.search/floatingattachedimagepossiblewatermark)`.
getX()	Gets the x-coordinate of this `[FloatingAttachedImagePossibleWatermark](../../com.groupdocs.watermark.search/floatingattachedimagepossiblewatermark)`.
getY()	Gets the y-coordinate of this `[FloatingAttachedImagePossibleWatermark](../../com.groupdocs.watermark.search/floatingattachedimagepossiblewatermark)`.

getParent()

public ContentPart getParent()

Gets the parent of this [FloatingAttachedImagePossibleWatermark](../../com.groupdocs.watermark.search/floatingattachedimagepossiblewatermark).

Returns: ContentPart - The parent of this [FloatingAttachedImagePossibleWatermark](../../com.groupdocs.watermark.search/floatingattachedimagepossiblewatermark).

getWidth()

public double getWidth()

Gets the width of this [FloatingAttachedImagePossibleWatermark](../../com.groupdocs.watermark.search/floatingattachedimagepossiblewatermark).

Returns: double - The width of this [FloatingAttachedImagePossibleWatermark](../../com.groupdocs.watermark.search/floatingattachedimagepossiblewatermark).

getHeight()

public double getHeight()

Gets the height of this [FloatingAttachedImagePossibleWatermark](../../com.groupdocs.watermark.search/floatingattachedimagepossiblewatermark).

Returns: double - The height of this [FloatingAttachedImagePossibleWatermark](../../com.groupdocs.watermark.search/floatingattachedimagepossiblewatermark).

getX()

public double getX()

Gets the x-coordinate of this [FloatingAttachedImagePossibleWatermark](../../com.groupdocs.watermark.search/floatingattachedimagepossiblewatermark).

Returns: double - The x-coordinate of this [FloatingAttachedImagePossibleWatermark](../../com.groupdocs.watermark.search/floatingattachedimagepossiblewatermark).

getY()

public double getY()

Gets the y-coordinate of this [FloatingAttachedImagePossibleWatermark](../../com.groupdocs.watermark.search/floatingattachedimagepossiblewatermark).

Returns: double - The y-coordinate of this [FloatingAttachedImagePossibleWatermark](../../com.groupdocs.watermark.search/floatingattachedimagepossiblewatermark).

Java: FormattedTextFragment

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

Inheritance: java.lang.Object

public abstract class FormattedTextFragment

Provides abstract base class for a fragment of formatted text in a content.

Constructors

Constructor	Description
FormattedTextFragment()

Methods

Method	Description
getText()	Gets the fragment text.
getFont()	Gets the font of the text.
getForegroundColor()	Gets the foreground color of the text.
getBackgroundColor()	Gets the background color of the text.

FormattedTextFragment()

public FormattedTextFragment()

getText()

public abstract String getText()

Gets the fragment text.

Returns: java.lang.String - The fragment text.

getFont()

public abstract Font getFont()

Gets the font of the text.

Returns: Font - The font of the text.

getForegroundColor()

public abstract Color getForegroundColor()

Gets the foreground color of the text.

Returns: Color - The foreground color of the text.

getBackgroundColor()

public abstract Color getBackgroundColor()

Gets the background color of the text.

Returns: Color - The background color of the text.

Java: FormattedTextFragmentCollection

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

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

public class FormattedTextFragmentCollection extends RemoveOnlyListBase<FormattedTextFragment>

Represents a mutable collection of formatted text fragments.

This collection contains the items of [FormattedTextFragment](../../com.groupdocs.watermark.search/formattedtextfragment) base type.

Constructors

Constructor	Description
FormattedTextFragmentCollection(int collectionType)

Methods

Method	Description
getCollectionType()	Gets the formatted fragment collection type.
getDefaultFont()
getDefaultForegroundColor()
getDefaultBackgroundColor()
getText()
add(String text)	Adds a formatted text fragment to the collection.
add(String text, Font font)	Adds a formatted text fragment to the collection.
add(String text, Font font, Color foregroundColor)	Adds a formatted text fragment to the collection.
add(String text, Font font, Color foregroundColor, Color backgroundColor)	Adds a formatted text fragment to the collection.
insert(int index, String text)	Inserts a formatted text fragment into the collection at a given index.
insert(int index, String text, Font font)	Inserts a formatted text fragment into the collection at a given index.
insert(int index, String text, Font font, Color foregroundColor)	Inserts a formatted text fragment into the collection at a given index.
insert(int index, String text, Font font, Color foregroundColor, Color backgroundColor)	Inserts a formatted text fragment into the collection at a given index.
createInDocument(int index, String text, Font font, Color foregroundColor, Color backgroundColor)
setText(String text)

FormattedTextFragmentCollection(int collectionType)

public FormattedTextFragmentCollection(int collectionType)

Parameters:

Parameter	Type	Description
collectionType	int

getCollectionType()

public final int getCollectionType()

Gets the formatted fragment collection type.

Returns: int - The formatted fragment collection type.

getDefaultFont()

public final Font getDefaultFont()

Returns: Font

getDefaultForegroundColor()

public final Color getDefaultForegroundColor()

Returns: Color

getDefaultBackgroundColor()

public final Color getDefaultBackgroundColor()

Returns: Color

getText()

public String getText()

Returns: java.lang.String

add(String text)

public final void add(String text)

Adds a formatted text fragment to the collection.

Parameters:

Parameter	Type	Description
text	java.lang.String	The fragment text.

add(String text, Font font)

public final void add(String text, Font font)

Adds a formatted text fragment to the collection.

Parameters:

Parameter	Type	Description
text	java.lang.String	The fragment text.
font	Font	The font of the text.

add(String text, Font font, Color foregroundColor)

public final void add(String text, Font font, Color foregroundColor)

Adds a formatted text fragment to the collection.

Parameters:

Parameter	Type	Description
text	java.lang.String	The fragment text.
font	Font	The font of the text.
foregroundColor	Color	The foreground color of the text.

add(String text, Font font, Color foregroundColor, Color backgroundColor)

public final void add(String text, Font font, Color foregroundColor, Color backgroundColor)

Adds a formatted text fragment to the collection.

Parameters:

Parameter	Type	Description
text	java.lang.String	The fragment text.
font	Font	The font of the text.
foregroundColor	Color	The foreground color of the text.
backgroundColor	Color	The background color of the text.

insert(int index, String text)

public final void insert(int index, String text)

Inserts a formatted text fragment into the collection at a given index.

Parameters:

Parameter	Type	Description
index	int	The zero-based index at which formatted text fragment should be inserted.
text	java.lang.String	The fragment text.

insert(int index, String text, Font font)

public final void insert(int index, String text, Font font)

Inserts a formatted text fragment into the collection at a given index.

Parameters:

Parameter	Type	Description
index	int	The zero-based index at which formatted text fragment should be inserted.
text	java.lang.String	The fragment text.
font	Font	The font of the text.

insert(int index, String text, Font font, Color foregroundColor)

public final void insert(int index, String text, Font font, Color foregroundColor)

Inserts a formatted text fragment into the collection at a given index.

Parameters:

Parameter	Type	Description
index	int	The zero-based index at which formatted text fragment should be inserted.
text	java.lang.String	The fragment text.
font	Font	The font of the text.
foregroundColor	Color	The foreground color of the text.

insert(int index, String text, Font font, Color foregroundColor, Color backgroundColor)

public final void insert(int index, String text, Font font, Color foregroundColor, Color backgroundColor)

Inserts a formatted text fragment into the collection at a given index.

Parameters:

Parameter	Type	Description
index	int	The zero-based index at which formatted text fragment should be inserted.
text	java.lang.String	The fragment text.
font	Font	The font of the text.
foregroundColor	Color	The foreground color of the text.
backgroundColor	Color	The background color of the text.

createInDocument(int index, String text, Font font, Color foregroundColor, Color backgroundColor)

public FormattedTextFragment createInDocument(int index, String text, Font font, Color foregroundColor, Color backgroundColor)

Parameters:

Parameter	Type	Description
index	int
text	java.lang.String
font	Font
foregroundColor	Color
backgroundColor	Color

Returns: FormattedTextFragment

setText(String text)

public void setText(String text)

Parameters:

Parameter	Type	Description
text	java.lang.String

Java: FormattedTextFragmentCollectionType

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

Inheritance: java.lang.Object

public final class FormattedTextFragmentCollectionType

Specifies the number of elements a formatted text fragment collection can contain.

Fields

Field	Description
UnlimitedFragments	Multiple styles are allowed, the collection can contain unlimited count of fragments.
SingleFragment	Whole text can be formatted with a single style, the collection can contain only one fragment.
NoFormattedText	Parent object doesn’t support text formatting, the collection is always empty.

UnlimitedFragments

public static final int UnlimitedFragments

Multiple styles are allowed, the collection can contain unlimited count of fragments.

SingleFragment

public static final int SingleFragment

Whole text can be formatted with a single style, the collection can contain only one fragment.

NoFormattedText

public static final int NoFormattedText

Parent object doesn’t support text formatting, the collection is always empty.

Java: HyperlinkPossibleWatermark

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

Inheritance: java.lang.Object, com.groupdocs.watermark.search.PossibleWatermark

public class HyperlinkPossibleWatermark extends PossibleWatermark

Represents possible hyperlink watermark in a PowerPoint content.

Constructors

Constructor	Description
HyperlinkPossibleWatermark(PossibleWatermark parentWatermark, IHyperlinkContainer hyperlinkContainer)

Methods

Method	Description
getParent()	Gets the parent of this `[HyperlinkPossibleWatermark](../../com.groupdocs.watermark.search/hyperlinkpossiblewatermark)`.
getWidth()	Gets the width of this `[HyperlinkPossibleWatermark](../../com.groupdocs.watermark.search/hyperlinkpossiblewatermark)`.
getHeight()	Gets the height of this `[HyperlinkPossibleWatermark](../../com.groupdocs.watermark.search/hyperlinkpossiblewatermark)`.
getX()	Gets the x-coordinate of this `[HyperlinkPossibleWatermark](../../com.groupdocs.watermark.search/hyperlinkpossiblewatermark)`.
getY()	Gets the y-coordinate of this `[HyperlinkPossibleWatermark](../../com.groupdocs.watermark.search/hyperlinkpossiblewatermark)`.
getRotateAngle()	Gets the rotate angle of this `[HyperlinkPossibleWatermark](../../com.groupdocs.watermark.search/hyperlinkpossiblewatermark)` in degrees.
getText()	Gets the url of this `[HyperlinkPossibleWatermark](../../com.groupdocs.watermark.search/hyperlinkpossiblewatermark)`.
setText(String value)	Sets the url of this `[HyperlinkPossibleWatermark](../../com.groupdocs.watermark.search/hyperlinkpossiblewatermark)`.
getUnitOfMeasurement()	Gets the unit of measurement `[UnitOfMeasurement](../../com.groupdocs.watermark.common/unitofmeasurement)` of this `[HyperlinkPossibleWatermark](../../com.groupdocs.watermark.search/hyperlinkpossiblewatermark)`.
remove()

HyperlinkPossibleWatermark(PossibleWatermark parentWatermark, IHyperlinkContainer hyperlinkContainer)

public HyperlinkPossibleWatermark(PossibleWatermark parentWatermark, IHyperlinkContainer hyperlinkContainer)

Parameters:

Parameter	Type	Description
parentWatermark	PossibleWatermark
hyperlinkContainer	IHyperlinkContainer

getParent()

public ContentPart getParent()

Gets the parent of this [HyperlinkPossibleWatermark](../../com.groupdocs.watermark.search/hyperlinkpossiblewatermark).

Returns: ContentPart - The parent of this [HyperlinkPossibleWatermark](../../com.groupdocs.watermark.search/hyperlinkpossiblewatermark).

getWidth()

public double getWidth()

Gets the width of this [HyperlinkPossibleWatermark](../../com.groupdocs.watermark.search/hyperlinkpossiblewatermark).

Returns: double - The width of this [HyperlinkPossibleWatermark](../../com.groupdocs.watermark.search/hyperlinkpossiblewatermark).

getHeight()

public double getHeight()

Gets the height of this [HyperlinkPossibleWatermark](../../com.groupdocs.watermark.search/hyperlinkpossiblewatermark).

Returns: double - The height of this [HyperlinkPossibleWatermark](../../com.groupdocs.watermark.search/hyperlinkpossiblewatermark).

getX()

public double getX()

Gets the x-coordinate of this [HyperlinkPossibleWatermark](../../com.groupdocs.watermark.search/hyperlinkpossiblewatermark).

Returns: double - The x-coordinate of this [HyperlinkPossibleWatermark](../../com.groupdocs.watermark.search/hyperlinkpossiblewatermark).

getY()

public double getY()

Gets the y-coordinate of this [HyperlinkPossibleWatermark](../../com.groupdocs.watermark.search/hyperlinkpossiblewatermark).

Returns: double - The y-coordinate of this [HyperlinkPossibleWatermark](../../com.groupdocs.watermark.search/hyperlinkpossiblewatermark).

getRotateAngle()

public double getRotateAngle()

Gets the rotate angle of this [HyperlinkPossibleWatermark](../../com.groupdocs.watermark.search/hyperlinkpossiblewatermark) in degrees.

Returns: double - The rotate angle of this [HyperlinkPossibleWatermark](../../com.groupdocs.watermark.search/hyperlinkpossiblewatermark).

getText()

public String getText()

Gets the url of this [HyperlinkPossibleWatermark](../../com.groupdocs.watermark.search/hyperlinkpossiblewatermark).

Returns: java.lang.String - The url of this [HyperlinkPossibleWatermark](../../com.groupdocs.watermark.search/hyperlinkpossiblewatermark).

setText(String value)

public void setText(String value)

Sets the url of this [HyperlinkPossibleWatermark](../../com.groupdocs.watermark.search/hyperlinkpossiblewatermark).

Parameters:

Parameter	Type	Description
value	java.lang.String	The url of this `[HyperlinkPossibleWatermark](../../com.groupdocs.watermark.search/hyperlinkpossiblewatermark)`.

getUnitOfMeasurement()

public int getUnitOfMeasurement()

Gets the unit of measurement [UnitOfMeasurement](../../com.groupdocs.watermark.common/unitofmeasurement) of this [HyperlinkPossibleWatermark](../../com.groupdocs.watermark.search/hyperlinkpossiblewatermark).

Returns: int - The unit of measurement [UnitOfMeasurement](../../com.groupdocs.watermark.common/unitofmeasurement) of this [HyperlinkPossibleWatermark](../../com.groupdocs.watermark.search/hyperlinkpossiblewatermark).

remove()

public void remove()

Java: ImageColorHistogramSearchCriteria

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

Inheritance: java.lang.Object, com.groupdocs.watermark.search.SearchCriteria, com.groupdocs.watermark.search.PageSearchCriteria, com.groupdocs.watermark.search.ImageSearchCriteria

public class ImageColorHistogramSearchCriteria extends ImageSearchCriteria

Represents search criteria for finding images in a content.

This search criteria uses image color histograms for calculating image similarity.

Constructors

Constructor	Description
ImageColorHistogramSearchCriteria(String filePath)	Initializes a new instance of the `[ImageColorHistogramSearchCriteria](../../com.groupdocs.watermark.search/imagecolorhistogramsearchcriteria)` class with a specified file path.
ImageColorHistogramSearchCriteria(InputStream stream)	Initializes a new instance of the `[ImageColorHistogramSearchCriteria](../../com.groupdocs.watermark.search/imagecolorhistogramsearchcriteria)` class with a specified stream.

Methods

Method	Description
getBinsCount()	Gets a count of bins that will be used for building color histograms.
setBinsCount(byte value)	Sets a count of bins that will be used for building color histograms.

ImageColorHistogramSearchCriteria(String filePath)

public ImageColorHistogramSearchCriteria(String filePath)

Initializes a new instance of the [ImageColorHistogramSearchCriteria](../../com.groupdocs.watermark.search/imagecolorhistogramsearchcriteria) class with a specified file path.

Parameters:

Parameter	Type	Description
filePath	java.lang.String	The file path to load image from.

ImageColorHistogramSearchCriteria(InputStream stream)

public ImageColorHistogramSearchCriteria(InputStream stream)

Initializes a new instance of the [ImageColorHistogramSearchCriteria](../../com.groupdocs.watermark.search/imagecolorhistogramsearchcriteria) class with a specified stream.

Parameters:

Parameter	Type	Description
stream	java.io.InputStream	The stream to load image from.

getBinsCount()

public final byte getBinsCount()

Gets a count of bins that will be used for building color histograms.

Returns: byte - The default value is 10.

setBinsCount(byte value)

public final void setBinsCount(byte value)

Sets a count of bins that will be used for building color histograms.

Parameters:

Parameter	Type	Description
value	byte	The default value is 10.

Java: ImageDctHashSearchCriteria

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

Inheritance: java.lang.Object, com.groupdocs.watermark.search.SearchCriteria, com.groupdocs.watermark.search.PageSearchCriteria, com.groupdocs.watermark.search.ImageSearchCriteria

public class ImageDctHashSearchCriteria extends ImageSearchCriteria

Represents a search criteria for finding images in a document.

This search criteria uses DCT based perceptual image hash for calculating image similarity.

Learn more:

Searching watermarks

The following example demonstrates how to search for images in the attached files (pdf).

WatermarkerSettings settings = new WatermarkerSettings(); settings.setSearchableObjects(new SearchableObjects()); settings.getSearchableObjects().setPdfSearchableObjects(PdfSearchableObjects.All); PdfLoadOptions loadOptions = new PdfLoadOptions(); Watermarker watermarker = new Watermarker(“D:\test.pdf”, loadOptions);

// Specify sample image to compare document images with ImageSearchCriteria criteria = new ImageDctHashSearchCriteria(“D:\sample.png”); // Search for similar images PossibleWatermarkCollection possibleWatermarks = watermarker.search(criteria); // Remove or modify found image watermarks // …

watermarker.close();

Constructors

Constructor	Description
ImageDctHashSearchCriteria(String filePath)	Initializes a new instance of the `[ImageDctHashSearchCriteria](../../com.groupdocs.watermark.search/imagedcthashsearchcriteria)` class with a specified file path.
ImageDctHashSearchCriteria(InputStream stream)	Initializes a new instance of the `[ImageDctHashSearchCriteria](../../com.groupdocs.watermark.search/imagedcthashsearchcriteria)` class with a specified stream.
ImageDctHashSearchCriteria(System.IO.Stream stream)

ImageDctHashSearchCriteria(String filePath)

public ImageDctHashSearchCriteria(String filePath)

Initializes a new instance of the [ImageDctHashSearchCriteria](../../com.groupdocs.watermark.search/imagedcthashsearchcriteria) class with a specified file path.

Parameters:

Parameter	Type	Description
filePath	java.lang.String	The file path to load image from.

ImageDctHashSearchCriteria(InputStream stream)

public ImageDctHashSearchCriteria(InputStream stream)

Initializes a new instance of the [ImageDctHashSearchCriteria](../../com.groupdocs.watermark.search/imagedcthashsearchcriteria) class with a specified stream.

Parameters:

Parameter	Type	Description
stream	java.io.InputStream	The stream to load image from.

ImageDctHashSearchCriteria(System.IO.Stream stream)

public ImageDctHashSearchCriteria(System.IO.Stream stream)

Parameters:

Parameter	Type	Description
stream	com.aspose.ms.System.IO.Stream

Java: ImageSearchCriteria

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

Inheritance: java.lang.Object, com.groupdocs.watermark.search.SearchCriteria, com.groupdocs.watermark.search.PageSearchCriteria

public abstract class ImageSearchCriteria extends PageSearchCriteria

Provides base class for image search criteria.

Methods

Method	Description
getMaxDifference()	Gets maximum allowed difference between images.
setMaxDifference(double value)	Sets maximum allowed difference between images.
getStream()
getTrueImages()
getFalseImages()
isSatisfiedBy(PossibleWatermark candidate)
accept(ICriteriaVisitor visitor)
resetCache()

getMaxDifference()

public final double getMaxDifference()

Gets maximum allowed difference between images.

Returns: double - The value should be between 0 and 1. 0 means that only identical images will be found.

setMaxDifference(double value)

public final void setMaxDifference(double value)

Sets maximum allowed difference between images.

Parameters:

Parameter	Type	Description
value	double	The value should be between 0 and 1. 0 means that only identical images will be found.

getStream()

public final StreamContainer getStream()

Returns: StreamContainer

getTrueImages()

public final System.Collections.Generic.List<WatermarkableImage> getTrueImages()

Returns: com.aspose.ms.System.Collections.Generic.List<com.groupdocs.watermark.contents.WatermarkableImage>

getFalseImages()

public final System.Collections.Generic.List<WatermarkableImage> getFalseImages()

Returns: com.aspose.ms.System.Collections.Generic.List<com.groupdocs.watermark.contents.WatermarkableImage>

isSatisfiedBy(PossibleWatermark candidate)

public boolean isSatisfiedBy(PossibleWatermark candidate)

Parameters:

Parameter	Type	Description
candidate	PossibleWatermark

Returns: boolean

accept(ICriteriaVisitor visitor)

public void accept(ICriteriaVisitor visitor)

Parameters:

Parameter	Type	Description
visitor	ICriteriaVisitor

resetCache()

public final void resetCache()

Java: ImageThumbnailSearchCriteria

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

Inheritance: java.lang.Object, com.groupdocs.watermark.search.SearchCriteria, com.groupdocs.watermark.search.PageSearchCriteria, com.groupdocs.watermark.search.ImageSearchCriteria

public class ImageThumbnailSearchCriteria extends ImageSearchCriteria

Represents search criteria for finding images in a content.

This search criteria uses image binarized thumbnail for calculating image similarity.

Constructors

Constructor	Description
ImageThumbnailSearchCriteria(String filePath)	Initializes a new instance of the `[ImageThumbnailSearchCriteria](../../com.groupdocs.watermark.search/imagethumbnailsearchcriteria)` class with a specified file path.
ImageThumbnailSearchCriteria(InputStream stream)	Initializes a new instance of the `[ImageThumbnailSearchCriteria](../../com.groupdocs.watermark.search/imagethumbnailsearchcriteria)` class with a specified stream.

Methods

Method	Description
getThumbnailSize()	Gets thumbnail size.
setThumbnailSize(byte value)	Sets thumbnail size.

ImageThumbnailSearchCriteria(String filePath)

public ImageThumbnailSearchCriteria(String filePath)

Initializes a new instance of the [ImageThumbnailSearchCriteria](../../com.groupdocs.watermark.search/imagethumbnailsearchcriteria) class with a specified file path.

Parameters:

Parameter	Type	Description
filePath	java.lang.String	The file path to load image from.

ImageThumbnailSearchCriteria(InputStream stream)

public ImageThumbnailSearchCriteria(InputStream stream)

Initializes a new instance of the [ImageThumbnailSearchCriteria](../../com.groupdocs.watermark.search/imagethumbnailsearchcriteria) class with a specified stream.

Parameters:

Parameter	Type	Description
stream	java.io.InputStream	The stream to load image from.

getThumbnailSize()

public final byte getThumbnailSize()

Gets thumbnail size.

Returns: byte - By default 32X32 thumbnail will be used.

setThumbnailSize(byte value)

public final void setThumbnailSize(byte value)

Sets thumbnail size.

Parameters:

Parameter	Type	Description
value	byte	By default 32X32 thumbnail will be used.

Java: IsImageSearchCriteria

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

Inheritance: java.lang.Object, com.groupdocs.watermark.search.SearchCriteria

public final class IsImageSearchCriteria extends SearchCriteria

Represents search criteria for filtering image watermarks only.

Constructors

Constructor	Description
IsImageSearchCriteria()	Initializes a new instance of the `[IsImageSearchCriteria](../../com.groupdocs.watermark.search/isimagesearchcriteria)` class.

Methods

Method	Description
isSatisfiedBy(PossibleWatermark candidate)
accept(ICriteriaVisitor visitor)

IsImageSearchCriteria()

public IsImageSearchCriteria()

Initializes a new instance of the [IsImageSearchCriteria](../../com.groupdocs.watermark.search/isimagesearchcriteria) class.

isSatisfiedBy(PossibleWatermark candidate)

public boolean isSatisfiedBy(PossibleWatermark candidate)

Parameters:

Parameter	Type	Description
candidate	PossibleWatermark

Returns: boolean

accept(ICriteriaVisitor visitor)

public void accept(ICriteriaVisitor visitor)

Parameters:

Parameter	Type	Description
visitor	ICriteriaVisitor

Java: IsTextSearchCriteria

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

Inheritance: java.lang.Object, com.groupdocs.watermark.search.SearchCriteria

public final class IsTextSearchCriteria extends SearchCriteria

Represents search criteria for filtering text watermarks only.

Constructors

Constructor	Description
IsTextSearchCriteria()	Initializes a new instance of the `[IsTextSearchCriteria](../../com.groupdocs.watermark.search/istextsearchcriteria)` class.

Methods

Method	Description
isSatisfiedBy(PossibleWatermark candidate)
accept(ICriteriaVisitor visitor)

IsTextSearchCriteria()

public IsTextSearchCriteria()

Initializes a new instance of the [IsTextSearchCriteria](../../com.groupdocs.watermark.search/istextsearchcriteria) class.

isSatisfiedBy(PossibleWatermark candidate)

public boolean isSatisfiedBy(PossibleWatermark candidate)

Parameters:

Parameter	Type	Description
candidate	PossibleWatermark

Returns: boolean

accept(ICriteriaVisitor visitor)

public void accept(ICriteriaVisitor visitor)

Parameters:

Parameter	Type	Description
visitor	ICriteriaVisitor

Java: NotSearchCriteria

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

Inheritance: java.lang.Object, com.groupdocs.watermark.search.SearchCriteria

public class NotSearchCriteria extends SearchCriteria

Represents NOT composite search criteria.

Methods

Method	Description
getWrapped()
isSatisfiedBy(PossibleWatermark candidate)
accept(ICriteriaVisitor visitor)

getWrapped()

public final SearchCriteria getWrapped()

Returns: SearchCriteria

isSatisfiedBy(PossibleWatermark candidate)

public boolean isSatisfiedBy(PossibleWatermark candidate)

Parameters:

Parameter	Type	Description
candidate	PossibleWatermark

Returns: boolean

accept(ICriteriaVisitor visitor)

public void accept(ICriteriaVisitor visitor)

Parameters:

Parameter	Type	Description
visitor	ICriteriaVisitor

Java: OrSearchCriteria

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

Inheritance: java.lang.Object, com.groupdocs.watermark.search.SearchCriteria

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

public class OrSearchCriteria extends SearchCriteria implements IBinaryOperation

Represents OR composite search criteria.

Methods

Method	Description
getLeft()	Gets the left search criteria.
getRight()	Gets the right search criteria.
isSatisfiedBy(PossibleWatermark candidate)
accept(ICriteriaVisitor visitor)

getLeft()

public final SearchCriteria getLeft()

Gets the left search criteria.

Returns: SearchCriteria - The left search criteria.

getRight()

public final SearchCriteria getRight()

Gets the right search criteria.

Returns: SearchCriteria - The right search criteria.

isSatisfiedBy(PossibleWatermark candidate)

public boolean isSatisfiedBy(PossibleWatermark candidate)

Parameters:

Parameter	Type	Description
candidate	PossibleWatermark

Returns: boolean

accept(ICriteriaVisitor visitor)

public void accept(ICriteriaVisitor visitor)

Parameters:

Parameter	Type	Description
visitor	ICriteriaVisitor

Java: PdfAnnotationPossibleWatermark

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

Inheritance: java.lang.Object, com.groupdocs.watermark.search.PossibleWatermark, com.groupdocs.watermark.search.TwoDObjectPossibleWatermark, com.groupdocs.watermark.search.ShapePossibleWatermark

public class PdfAnnotationPossibleWatermark extends ShapePossibleWatermark<PdfAnnotation>

Represents possible annotation watermark in a pdf document.

Constructors

Constructor	Description
PdfAnnotationPossibleWatermark(PdfAnnotation annotation, PdfAnnotationCollection annotationCollection)

Methods

Method	Description
getParent()	Gets the parent of this `[PdfAnnotationPossibleWatermark](../../com.groupdocs.watermark.search/pdfannotationpossiblewatermark)`.

PdfAnnotationPossibleWatermark(PdfAnnotation annotation, PdfAnnotationCollection annotationCollection)

public PdfAnnotationPossibleWatermark(PdfAnnotation annotation, PdfAnnotationCollection annotationCollection)

Parameters:

Parameter	Type	Description
annotation	PdfAnnotation
annotationCollection	PdfAnnotationCollection

getParent()

public ContentPart getParent()

Gets the parent of this [PdfAnnotationPossibleWatermark](../../com.groupdocs.watermark.search/pdfannotationpossiblewatermark).

Returns: ContentPart - The parent of this [PdfAnnotationPossibleWatermark](../../com.groupdocs.watermark.search/pdfannotationpossiblewatermark).

Java: PdfArtifactPossibleWatermark

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

Inheritance: java.lang.Object, com.groupdocs.watermark.search.PossibleWatermark, com.groupdocs.watermark.search.TwoDObjectPossibleWatermark, com.groupdocs.watermark.search.ShapePossibleWatermark

public class PdfArtifactPossibleWatermark extends ShapePossibleWatermark<PdfArtifact>

Represents possible artifact watermark in a pdf content.

Constructors

Constructor	Description
PdfArtifactPossibleWatermark(PdfArtifact artifact, PdfArtifactCollection artifactCollection)

Methods

Method	Description
getParent()	Gets the parent of this `[PdfArtifactPossibleWatermark](../../com.groupdocs.watermark.search/pdfartifactpossiblewatermark)`.

PdfArtifactPossibleWatermark(PdfArtifact artifact, PdfArtifactCollection artifactCollection)

public PdfArtifactPossibleWatermark(PdfArtifact artifact, PdfArtifactCollection artifactCollection)

Parameters:

Parameter	Type	Description
artifact	PdfArtifact
artifactCollection	PdfArtifactCollection

getParent()

public ContentPart getParent()

Gets the parent of this [PdfArtifactPossibleWatermark](../../com.groupdocs.watermark.search/pdfartifactpossiblewatermark).

Returns: ContentPart - The parent of this [PdfArtifactPossibleWatermark](../../com.groupdocs.watermark.search/pdfartifactpossiblewatermark).

Java: PdfAttachedImagePossibleWatermark

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

Inheritance: java.lang.Object, com.groupdocs.watermark.search.PossibleWatermark, com.groupdocs.watermark.search.AttachedImagePossibleWatermark

public class PdfAttachedImagePossibleWatermark extends AttachedImagePossibleWatermark<PdfAttachment>

Represents possible image watermark in pdf document attachment.

Constructors

Constructor	Description
PdfAttachedImagePossibleWatermark(PdfContent content, PdfAttachment attachment)

PdfAttachedImagePossibleWatermark(PdfContent content, PdfAttachment attachment)

public PdfAttachedImagePossibleWatermark(PdfContent content, PdfAttachment attachment)

Parameters:

Parameter	Type	Description
content	PdfContent
attachment	PdfAttachment

Java: PdfHyperlinkPossibleWatermark

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

Inheritance: java.lang.Object, com.groupdocs.watermark.search.PossibleWatermark, com.groupdocs.watermark.search.HyperlinkPossibleWatermark

public class PdfHyperlinkPossibleWatermark extends HyperlinkPossibleWatermark

Represents possible hyperlink watermark in a pdf document.

Constructors

Constructor	Description
PdfHyperlinkPossibleWatermark(GoToURIAction action, PdfAnnotationPossibleWatermark parentWatermark)
PdfHyperlinkPossibleWatermark(LaunchAction action, PdfAnnotationPossibleWatermark parentWatermark)

Methods

Method	Description
getText()	Gets the url of this `[PdfHyperlinkPossibleWatermark](../../com.groupdocs.watermark.search/pdfhyperlinkpossiblewatermark)`.
setText(String value)
remove()

PdfHyperlinkPossibleWatermark(GoToURIAction action, PdfAnnotationPossibleWatermark parentWatermark)

public PdfHyperlinkPossibleWatermark(GoToURIAction action, PdfAnnotationPossibleWatermark parentWatermark)

Parameters:

Parameter	Type	Description
action	com.aspose.pdf.GoToURIAction
parentWatermark	PdfAnnotationPossibleWatermark

PdfHyperlinkPossibleWatermark(LaunchAction action, PdfAnnotationPossibleWatermark parentWatermark)

public PdfHyperlinkPossibleWatermark(LaunchAction action, PdfAnnotationPossibleWatermark parentWatermark)

Parameters:

Parameter	Type	Description
action	com.aspose.pdf.LaunchAction
parentWatermark	PdfAnnotationPossibleWatermark

getText()

public String getText()

Gets the url of this [PdfHyperlinkPossibleWatermark](../../com.groupdocs.watermark.search/pdfhyperlinkpossiblewatermark).

Returns: java.lang.String - The url of this [PdfHyperlinkPossibleWatermark](../../com.groupdocs.watermark.search/pdfhyperlinkpossiblewatermark).

setText(String value)

public void setText(String value)

Sets the url of this [HyperlinkPossibleWatermark](../../com.groupdocs.watermark.search/hyperlinkpossiblewatermark).

Parameters:

Parameter	Type	Description
value	java.lang.String

remove()

public void remove()

Java: PdfSearchableObjects

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

Inheritance: java.lang.Object

public final class PdfSearchableObjects

Specifies flags representing pdf content objects that are to be included in a watermark search.

Fields

Field	Description
None	Specifies no search objects.
XObjects	Search in XObjects.
Artifacts	Search in artifacts.
Annotations	Search in annotations.
Text	Search in content text.
Hyperlinks	Search in hyperlinks.
AttachedImages	Search in attached images.
Vector	Search in attached operators.
All	Search in all content objects.

Methods

Method	Description
getValues()	Gets an array of all values of `[PdfSearchableObjects](../../com.groupdocs.watermark.search/pdfsearchableobjects)` enumeration.

None

public static final int None

Specifies no search objects.

XObjects

public static final int XObjects

Search in XObjects.

Artifacts

public static final int Artifacts

Search in artifacts.

Annotations

public static final int Annotations

Search in annotations.

Text

public static final int Text

Search in content text.

Hyperlinks

public static final int Hyperlinks

Search in hyperlinks.

AttachedImages

public static final int AttachedImages

Search in attached images.

Vector

public static final int Vector

Search in attached operators.

All

public static final int All

Search in all content objects.

getValues()

public static final int[] getValues()

Gets an array of all values of [PdfSearchableObjects](../../com.groupdocs.watermark.search/pdfsearchableobjects) enumeration.

Returns: int[] - The array of all values of [PdfSearchableObjects](../../com.groupdocs.watermark.search/pdfsearchableobjects) enumeration.

Java: PdfTextPossibleWatermark

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

Inheritance: java.lang.Object, com.groupdocs.watermark.search.PossibleWatermark

public class PdfTextPossibleWatermark extends PossibleWatermark

Represents possible watermark in a pdf document text.

Constructors

Constructor	Description
PdfTextPossibleWatermark(PdfPage parent, TextFragment fragment)

Methods

Method	Description
getParent()	Gets the parent of this `[PdfTextPossibleWatermark](../../com.groupdocs.watermark.search/pdftextpossiblewatermark)`.
getWidth()	Gets the width of this `[PdfTextPossibleWatermark](../../com.groupdocs.watermark.search/pdftextpossiblewatermark)` in points.
getHeight()	Gets the height of this `[PdfTextPossibleWatermark](../../com.groupdocs.watermark.search/pdftextpossiblewatermark)` in points.
getX()	Gets the horizontal offset of this `[PdfTextPossibleWatermark](../../com.groupdocs.watermark.search/pdftextpossiblewatermark)` from page left border in points.
getY()	Gets the vertical offset of this `[PdfTextPossibleWatermark](../../com.groupdocs.watermark.search/pdftextpossiblewatermark)` from page bottom border in points.
getRotateAngle()	Gets the rotate angle of this `[PdfTextPossibleWatermark](../../com.groupdocs.watermark.search/pdftextpossiblewatermark)` in degrees.
getText()	Gets the text of this `[PdfTextPossibleWatermark](../../com.groupdocs.watermark.search/pdftextpossiblewatermark)`.
setText(String value)	Sets the text of this `[PdfTextPossibleWatermark](../../com.groupdocs.watermark.search/pdftextpossiblewatermark)`.
getFormattedTextFragments()	Gets the collection of formatted text fragments of this `[PdfTextPossibleWatermark](../../com.groupdocs.watermark.search/pdftextpossiblewatermark)`.
getUnitOfMeasurement()	Gets the `[UnitOfMeasurement](../../com.groupdocs.watermark.common/unitofmeasurement)` of this `[PdfTextPossibleWatermark](../../com.groupdocs.watermark.search/pdftextpossiblewatermark)`.
remove()

PdfTextPossibleWatermark(PdfPage parent, TextFragment fragment)

public PdfTextPossibleWatermark(PdfPage parent, TextFragment fragment)

Parameters:

Parameter	Type	Description
parent	PdfPage
fragment	com.aspose.pdf.TextFragment

getParent()

public ContentPart getParent()

Gets the parent of this [PdfTextPossibleWatermark](../../com.groupdocs.watermark.search/pdftextpossiblewatermark).

Returns: ContentPart - The parent of this [PdfTextPossibleWatermark](../../com.groupdocs.watermark.search/pdftextpossiblewatermark).

getWidth()

public double getWidth()

Gets the width of this [PdfTextPossibleWatermark](../../com.groupdocs.watermark.search/pdftextpossiblewatermark) in points.

Returns: double - The width of this [PdfTextPossibleWatermark](../../com.groupdocs.watermark.search/pdftextpossiblewatermark) in points.

getHeight()

public double getHeight()

Gets the height of this [PdfTextPossibleWatermark](../../com.groupdocs.watermark.search/pdftextpossiblewatermark) in points.

Returns: double - The height of this [PdfTextPossibleWatermark](../../com.groupdocs.watermark.search/pdftextpossiblewatermark) in points.

getX()

public double getX()

Gets the horizontal offset of this [PdfTextPossibleWatermark](../../com.groupdocs.watermark.search/pdftextpossiblewatermark) from page left border in points.

Returns: double - The x-coordinate of this [PdfTextPossibleWatermark](../../com.groupdocs.watermark.search/pdftextpossiblewatermark).

getY()

public double getY()

Gets the vertical offset of this [PdfTextPossibleWatermark](../../com.groupdocs.watermark.search/pdftextpossiblewatermark) from page bottom border in points.

Returns: double - The y-coordinate of this [PdfTextPossibleWatermark](../../com.groupdocs.watermark.search/pdftextpossiblewatermark).

getRotateAngle()

public double getRotateAngle()

Gets the rotate angle of this [PdfTextPossibleWatermark](../../com.groupdocs.watermark.search/pdftextpossiblewatermark) in degrees.

Returns: double - The value is always 0 for this type of possible watermark.

getText()

public String getText()

Gets the text of this [PdfTextPossibleWatermark](../../com.groupdocs.watermark.search/pdftextpossiblewatermark).

Returns: java.lang.String - The text of this [PdfTextPossibleWatermark](../../com.groupdocs.watermark.search/pdftextpossiblewatermark).

setText(String value)

public void setText(String value)

Sets the text of this [PdfTextPossibleWatermark](../../com.groupdocs.watermark.search/pdftextpossiblewatermark).

Parameters:

Parameter	Type	Description
value	java.lang.String	The text of this `[PdfTextPossibleWatermark](../../com.groupdocs.watermark.search/pdftextpossiblewatermark)`.

getFormattedTextFragments()

public FormattedTextFragmentCollection getFormattedTextFragments()

Gets the collection of formatted text fragments of this [PdfTextPossibleWatermark](../../com.groupdocs.watermark.search/pdftextpossiblewatermark).

Returns: FormattedTextFragmentCollection - The collection of formatted text fragments of this [PdfTextPossibleWatermark](../../com.groupdocs.watermark.search/pdftextpossiblewatermark).

getUnitOfMeasurement()

public int getUnitOfMeasurement()

Gets the [UnitOfMeasurement](../../com.groupdocs.watermark.common/unitofmeasurement) of this [PdfTextPossibleWatermark](../../com.groupdocs.watermark.search/pdftextpossiblewatermark).

Returns: int - [UnitOfMeasurement](../../com.groupdocs.watermark.common/unitofmeasurement) of this [PdfTextPossibleWatermark](../../com.groupdocs.watermark.search/pdftextpossiblewatermark).

remove()

public void remove()

Java: PdfXObjectPossibleWatermark

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

Inheritance: java.lang.Object, com.groupdocs.watermark.search.PossibleWatermark, com.groupdocs.watermark.search.TwoDObjectPossibleWatermark, com.groupdocs.watermark.search.ShapePossibleWatermark

public class PdfXObjectPossibleWatermark extends ShapePossibleWatermark<PdfXObject>

Represents possible XObject watermark in a pdf content.

Constructors

Constructor	Description
PdfXObjectPossibleWatermark(PdfXObject xObject, PdfXObjectCollection xObjectCollection)

Methods

Method	Description
getParent()	Gets the parent of this `[PdfXObjectPossibleWatermark](../../com.groupdocs.watermark.search/pdfxobjectpossiblewatermark)`.

PdfXObjectPossibleWatermark(PdfXObject xObject, PdfXObjectCollection xObjectCollection)

public PdfXObjectPossibleWatermark(PdfXObject xObject, PdfXObjectCollection xObjectCollection)

Parameters:

Parameter	Type	Description
xObject	PdfXObject
xObjectCollection	PdfXObjectCollection

getParent()

public ContentPart getParent()

Gets the parent of this [PdfXObjectPossibleWatermark](../../com.groupdocs.watermark.search/pdfxobjectpossiblewatermark).

Returns: ContentPart - The parent of this [PdfXObjectPossibleWatermark](../../com.groupdocs.watermark.search/pdfxobjectpossiblewatermark).

Java: PossibleWatermark

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

Inheritance: java.lang.Object

public abstract class PossibleWatermark

Represents possible watermark found in a document.

Constructors

Constructor	Description
PossibleWatermark()

Methods

Method	Description
getParent()	Gets the parent of this `[PossibleWatermark](../../com.groupdocs.watermark.search/possiblewatermark)`.
getPageNumber()
getWidth()	Gets the width of this `[PossibleWatermark](../../com.groupdocs.watermark.search/possiblewatermark)`.
getHeight()	Gets the height of this `[PossibleWatermark](../../com.groupdocs.watermark.search/possiblewatermark)`.
getX()	Gets the x-coordinate of this `[PossibleWatermark](../../com.groupdocs.watermark.search/possiblewatermark)`.
getY()	Gets the y-coordinate of this `[PossibleWatermark](../../com.groupdocs.watermark.search/possiblewatermark)`.
getRotateAngle()	Gets the rotate angle of this `[PossibleWatermark](../../com.groupdocs.watermark.search/possiblewatermark)` in degrees.
getText()	Gets the text of this `[PossibleWatermark](../../com.groupdocs.watermark.search/possiblewatermark)`.
setText(String value)	Sets the text of this `[PossibleWatermark](../../com.groupdocs.watermark.search/possiblewatermark)`.
getFormattedTextFragments()	Gets the collection of formatted text fragments of this `[PossibleWatermark](../../com.groupdocs.watermark.search/possiblewatermark)`.
getImageData()	Gets or sets the image of this `[PossibleWatermark](../../com.groupdocs.watermark.search/possiblewatermark)`.
setImageData(byte[] value)
getUnitOfMeasurement()	Gets the unit of measurement `[UnitOfMeasurement](../../com.groupdocs.watermark.common/unitofmeasurement)` of this `[PossibleWatermark](../../com.groupdocs.watermark.search/possiblewatermark)`.
getCollection()
setCollection(PossibleWatermarkCollection value)
getImageSize()
getImageInternally()
remove()

PossibleWatermark()

public PossibleWatermark()

getParent()

public abstract ContentPart getParent()

Gets the parent of this [PossibleWatermark](../../com.groupdocs.watermark.search/possiblewatermark).

Returns: ContentPart - The parent of this [PossibleWatermark](../../com.groupdocs.watermark.search/possiblewatermark).

getPageNumber()

public Integer getPageNumber()

Returns: java.lang.Integer

getWidth()

public double getWidth()

Gets the width of this [PossibleWatermark](../../com.groupdocs.watermark.search/possiblewatermark).

Returns: double - The width of this [PossibleWatermark](../../com.groupdocs.watermark.search/possiblewatermark).

getHeight()

public double getHeight()

Gets the height of this [PossibleWatermark](../../com.groupdocs.watermark.search/possiblewatermark).

Returns: double - The height of this [PossibleWatermark](../../com.groupdocs.watermark.search/possiblewatermark).

getX()

public double getX()

Gets the x-coordinate of this [PossibleWatermark](../../com.groupdocs.watermark.search/possiblewatermark).

Returns: double - The x-coordinate of this [PossibleWatermark](../../com.groupdocs.watermark.search/possiblewatermark).

getY()

public double getY()

Gets the y-coordinate of this [PossibleWatermark](../../com.groupdocs.watermark.search/possiblewatermark).

Returns: double - The y-coordinate of this [PossibleWatermark](../../com.groupdocs.watermark.search/possiblewatermark).

getRotateAngle()

public double getRotateAngle()

Gets the rotate angle of this [PossibleWatermark](../../com.groupdocs.watermark.search/possiblewatermark) in degrees.

Returns: double - The rotate angle of this [PossibleWatermark](../../com.groupdocs.watermark.search/possiblewatermark).

getText()

public String getText()

Gets the text of this [PossibleWatermark](../../com.groupdocs.watermark.search/possiblewatermark).

Returns: java.lang.String - The text of this [PossibleWatermark](../../com.groupdocs.watermark.search/possiblewatermark).

setText(String value)

public void setText(String value)

Sets the text of this [PossibleWatermark](../../com.groupdocs.watermark.search/possiblewatermark).

Parameters:

Parameter	Type	Description
value	java.lang.String	The text of this `[PossibleWatermark](../../com.groupdocs.watermark.search/possiblewatermark)`.

getFormattedTextFragments()

public FormattedTextFragmentCollection getFormattedTextFragments()

Gets the collection of formatted text fragments of this [PossibleWatermark](../../com.groupdocs.watermark.search/possiblewatermark).

Returns: FormattedTextFragmentCollection - The collection of formatted text fragments of this [PossibleWatermark](../../com.groupdocs.watermark.search/possiblewatermark).

getImageData()

public final byte[] getImageData()

Gets or sets the image of this [PossibleWatermark](../../com.groupdocs.watermark.search/possiblewatermark).

Returns: byte[] - The image of this [PossibleWatermark](../../com.groupdocs.watermark.search/possiblewatermark) or null if the watermark has no image.

setImageData(byte[] value)

public final void setImageData(byte[] value)

Parameters:

Parameter	Type	Description
value	byte[]

getUnitOfMeasurement()

public int getUnitOfMeasurement()

Gets the unit of measurement [UnitOfMeasurement](../../com.groupdocs.watermark.common/unitofmeasurement) of this [PossibleWatermark](../../com.groupdocs.watermark.search/possiblewatermark).

Returns: int - The unit of measurement [UnitOfMeasurement](../../com.groupdocs.watermark.common/unitofmeasurement) of this [PossibleWatermark](../../com.groupdocs.watermark.search/possiblewatermark).

getCollection()

public final PossibleWatermarkCollection getCollection()

Returns: PossibleWatermarkCollection

setCollection(PossibleWatermarkCollection value)

public final void setCollection(PossibleWatermarkCollection value)

Parameters:

Parameter	Type	Description
value	PossibleWatermarkCollection

getImageSize()

public final Size getImageSize()

Returns: Size

getImageInternally()

public WatermarkableImage getImageInternally()

Returns: WatermarkableImage

remove()

public abstract void remove()

Java: PossibleWatermarkCollection

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

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

public class PossibleWatermarkCollection extends RemoveOnlyListBase<PossibleWatermark>

Represents a collection of possible watermarks found in a content.

This collection contains the items of [PossibleWatermark](../../com.groupdocs.watermark.search/possiblewatermark) type.

Constructors

Constructor	Description
PossibleWatermarkCollection()

Methods

Method	Description
addRangeInternally(System.Collections.Generic.IGenericEnumerable collection)
addInternally(PossibleWatermark item)
removeFromDocument(PossibleWatermark item)

PossibleWatermarkCollection()

public PossibleWatermarkCollection()

addRangeInternally(System.Collections.Generic.IGenericEnumerable collection)

public final void addRangeInternally(System.Collections.Generic.IGenericEnumerable<PossibleWatermark> collection)

Parameters:

Parameter	Type	Description
collection	com.aspose.ms.System.Collections.Generic.IGenericEnumerable<com.groupdocs.watermark.search.PossibleWatermark>

addInternally(PossibleWatermark item)

public void addInternally(PossibleWatermark item)

Parameters:

Parameter	Type	Description
item	PossibleWatermark

removeFromDocument(PossibleWatermark item)

public void removeFromDocument(PossibleWatermark item)

Parameters:

Parameter	Type	Description
item	PossibleWatermark

Java: PresentationBackgroundPossibleWatermark

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

Inheritance: java.lang.Object, com.groupdocs.watermark.search.PossibleWatermark

public class PresentationBackgroundPossibleWatermark extends PossibleWatermark

Represents possible background watermark in a PowerPoint document.

Constructors

Constructor	Description
PresentationBackgroundPossibleWatermark(PresentationBaseSlide slide)

Methods

Method	Description
getParent()	Gets the parent of this `[PresentationBackgroundPossibleWatermark](../../com.groupdocs.watermark.search/presentationbackgroundpossiblewatermark)`.
getWidth()	Gets the width of this `[PresentationBackgroundPossibleWatermark](../../com.groupdocs.watermark.search/presentationbackgroundpossiblewatermark)` in points.
getHeight()	Gets the height of this `[PresentationBackgroundPossibleWatermark](../../com.groupdocs.watermark.search/presentationbackgroundpossiblewatermark)` in points.
getX()	Gets the horizontal offset of this `[PresentationBackgroundPossibleWatermark](../../com.groupdocs.watermark.search/presentationbackgroundpossiblewatermark)` from slide left border in points.
getY()	Gets the vertical offset of this `[PresentationBackgroundPossibleWatermark](../../com.groupdocs.watermark.search/presentationbackgroundpossiblewatermark)` from slide top border in points.
getRotateAngle()	Gets the rotate angle of this `[PresentationBackgroundPossibleWatermark](../../com.groupdocs.watermark.search/presentationbackgroundpossiblewatermark)` in degrees.
getUnitOfMeasurement()	Gets the `[UnitOfMeasurement](../../com.groupdocs.watermark.common/unitofmeasurement)` of this `[PresentationBackgroundPossibleWatermark](../../com.groupdocs.watermark.search/presentationbackgroundpossiblewatermark)`.
getImageInternally()
remove()

PresentationBackgroundPossibleWatermark(PresentationBaseSlide slide)

public PresentationBackgroundPossibleWatermark(PresentationBaseSlide slide)

Parameters:

Parameter	Type	Description
slide	PresentationBaseSlide

getParent()

public ContentPart getParent()

Gets the parent of this [PresentationBackgroundPossibleWatermark](../../com.groupdocs.watermark.search/presentationbackgroundpossiblewatermark).

Returns: ContentPart - The parent of this [PresentationBackgroundPossibleWatermark](../../com.groupdocs.watermark.search/presentationbackgroundpossiblewatermark).

getWidth()

public double getWidth()

Gets the width of this [PresentationBackgroundPossibleWatermark](../../com.groupdocs.watermark.search/presentationbackgroundpossiblewatermark) in points.

Returns: double - The width of this [PresentationBackgroundPossibleWatermark](../../com.groupdocs.watermark.search/presentationbackgroundpossiblewatermark) in points.

getHeight()

public double getHeight()

Gets the height of this [PresentationBackgroundPossibleWatermark](../../com.groupdocs.watermark.search/presentationbackgroundpossiblewatermark) in points.

Returns: double - The height of this [PresentationBackgroundPossibleWatermark](../../com.groupdocs.watermark.search/presentationbackgroundpossiblewatermark) in points.

getX()

public double getX()

Gets the horizontal offset of this [PresentationBackgroundPossibleWatermark](../../com.groupdocs.watermark.search/presentationbackgroundpossiblewatermark) from slide left border in points.

Returns: double - The x-coordinate of this [PresentationBackgroundPossibleWatermark](../../com.groupdocs.watermark.search/presentationbackgroundpossiblewatermark).

getY()

public double getY()

Gets the vertical offset of this [PresentationBackgroundPossibleWatermark](../../com.groupdocs.watermark.search/presentationbackgroundpossiblewatermark) from slide top border in points.

Returns: double - The y-coordinate of this [PresentationBackgroundPossibleWatermark](../../com.groupdocs.watermark.search/presentationbackgroundpossiblewatermark).

getRotateAngle()

public double getRotateAngle()

Gets the rotate angle of this [PresentationBackgroundPossibleWatermark](../../com.groupdocs.watermark.search/presentationbackgroundpossiblewatermark) in degrees.

Returns: double - The rotate angle of this [PresentationBackgroundPossibleWatermark](../../com.groupdocs.watermark.search/presentationbackgroundpossiblewatermark) in degrees.

getUnitOfMeasurement()

public int getUnitOfMeasurement()

Gets the [UnitOfMeasurement](../../com.groupdocs.watermark.common/unitofmeasurement) of this [PresentationBackgroundPossibleWatermark](../../com.groupdocs.watermark.search/presentationbackgroundpossiblewatermark).

Returns: int - The [UnitOfMeasurement](../../com.groupdocs.watermark.common/unitofmeasurement) of this [PresentationBackgroundPossibleWatermark](../../com.groupdocs.watermark.search/presentationbackgroundpossiblewatermark).

getImageInternally()

public WatermarkableImage getImageInternally()

Returns: WatermarkableImage

remove()

public void remove()

Java: PresentationChartBackgroundPossibleWatermark

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

Inheritance: java.lang.Object, com.groupdocs.watermark.search.PossibleWatermark, com.groupdocs.watermark.search.TwoDObjectPossibleWatermark

public class PresentationChartBackgroundPossibleWatermark extends TwoDObjectPossibleWatermark

Represents possible background watermark in a PowerPoint chart.

Constructors

Constructor	Description
PresentationChartBackgroundPossibleWatermark(PresentationChart chart)

Methods

Method	Description
getParent()	Gets the parent of this `[PresentationChartBackgroundPossibleWatermark](../../com.groupdocs.watermark.search/presentationchartbackgroundpossiblewatermark)`.
getRotateAngle()	Gets the rotate angle of this `[PresentationChartBackgroundPossibleWatermark](../../com.groupdocs.watermark.search/presentationchartbackgroundpossiblewatermark)` in degrees.
getUnitOfMeasurement()	Gets the `[UnitOfMeasurement](../../com.groupdocs.watermark.common/unitofmeasurement)` of this `[PresentationChartBackgroundPossibleWatermark](../../com.groupdocs.watermark.search/presentationchartbackgroundpossiblewatermark)`.
getImageInternally()
remove()

PresentationChartBackgroundPossibleWatermark(PresentationChart chart)

public PresentationChartBackgroundPossibleWatermark(PresentationChart chart)

Parameters:

Parameter	Type	Description
chart	PresentationChart

getParent()

public ContentPart getParent()

Gets the parent of this [PresentationChartBackgroundPossibleWatermark](../../com.groupdocs.watermark.search/presentationchartbackgroundpossiblewatermark).

Returns: ContentPart - The parent of this [PresentationChartBackgroundPossibleWatermark](../../com.groupdocs.watermark.search/presentationchartbackgroundpossiblewatermark).

getRotateAngle()

public double getRotateAngle()

Gets the rotate angle of this [PresentationChartBackgroundPossibleWatermark](../../com.groupdocs.watermark.search/presentationchartbackgroundpossiblewatermark) in degrees.

Returns: double - The rotate angle of this [PresentationChartBackgroundPossibleWatermark](../../com.groupdocs.watermark.search/presentationchartbackgroundpossiblewatermark) in degrees.

getUnitOfMeasurement()

public int getUnitOfMeasurement()

Gets the [UnitOfMeasurement](../../com.groupdocs.watermark.common/unitofmeasurement) of this [PresentationChartBackgroundPossibleWatermark](../../com.groupdocs.watermark.search/presentationchartbackgroundpossiblewatermark).

Returns: int - The [UnitOfMeasurement](../../com.groupdocs.watermark.common/unitofmeasurement) of this [PresentationChartBackgroundPossibleWatermark](../../com.groupdocs.watermark.search/presentationchartbackgroundpossiblewatermark).

getImageInternally()

public WatermarkableImage getImageInternally()

Returns: WatermarkableImage

remove()

public void remove()

Java: PresentationHyperlinkPossibleWatermark

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

Inheritance: java.lang.Object, com.groupdocs.watermark.search.PossibleWatermark, com.groupdocs.watermark.search.HyperlinkPossibleWatermark

public class PresentationHyperlinkPossibleWatermark extends HyperlinkPossibleWatermark

Represents possible hyperlink watermark in a PowerPoint document.

Constructors

Constructor	Description
PresentationHyperlinkPossibleWatermark(PossibleWatermark parentWatermark, IPresentationHyperlinkContainer hyperlinkContainer, int actionType)

Methods

Method	Description
getText()	Gets the url of this `[HyperlinkPossibleWatermark](../../com.groupdocs.watermark.search/hyperlinkpossiblewatermark)`.
setText(String value)	Sets the url of this `[HyperlinkPossibleWatermark](../../com.groupdocs.watermark.search/hyperlinkpossiblewatermark)`.
remove()

PresentationHyperlinkPossibleWatermark(PossibleWatermark parentWatermark, IPresentationHyperlinkContainer hyperlinkContainer, int actionType)

public PresentationHyperlinkPossibleWatermark(PossibleWatermark parentWatermark, IPresentationHyperlinkContainer hyperlinkContainer, int actionType)

Parameters:

Parameter	Type	Description
parentWatermark	PossibleWatermark
hyperlinkContainer	IPresentationHyperlinkContainer
actionType	int

getText()

public String getText()

Gets the url of this [HyperlinkPossibleWatermark](../../com.groupdocs.watermark.search/hyperlinkpossiblewatermark).

Returns: java.lang.String - The url of this [HyperlinkPossibleWatermark](../../com.groupdocs.watermark.search/hyperlinkpossiblewatermark).

setText(String value)

public void setText(String value)

Sets the url of this [HyperlinkPossibleWatermark](../../com.groupdocs.watermark.search/hyperlinkpossiblewatermark).

Parameters:

Parameter	Type	Description
value	java.lang.String	The url of this `[HyperlinkPossibleWatermark](../../com.groupdocs.watermark.search/hyperlinkpossiblewatermark)`.

remove()

public void remove()

Java: PresentationSearchableObjects

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

Inheritance: java.lang.Object

public final class PresentationSearchableObjects

Specifies flags representing PowerPoint content objects that are to be included in a watermark search.

Fields

Field	Description
None	Specifies no search objects.
Shapes	Search in shapes.
ChartsBackgrounds	Search in charts backgrounds.
SlidesBackgrounds	Search in slides backgrounds.
Hyperlinks	Search in hyperlinks.
All	Search in all content objects.

Methods

Method	Description
getValues()	Gets an array of all values of `[PresentationSearchableObjects](../../com.groupdocs.watermark.search/presentationsearchableobjects)` enumeration.

None

public static final int None

Specifies no search objects.

Shapes

public static final int Shapes

Search in shapes.

ChartsBackgrounds

public static final int ChartsBackgrounds

Search in charts backgrounds.

SlidesBackgrounds

public static final int SlidesBackgrounds

Search in slides backgrounds.

Hyperlinks

public static final int Hyperlinks

Search in hyperlinks.

All

public static final int All

Search in all content objects.

getValues()

public static final int[] getValues()

Gets an array of all values of [PresentationSearchableObjects](../../com.groupdocs.watermark.search/presentationsearchableobjects) enumeration.

Returns: int[] - The array of all values of [PresentationSearchableObjects](../../com.groupdocs.watermark.search/presentationsearchableobjects) enumeration.

Java: PresentationShapePossibleWatermark

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

Inheritance: java.lang.Object, com.groupdocs.watermark.search.PossibleWatermark, com.groupdocs.watermark.search.TwoDObjectPossibleWatermark, com.groupdocs.watermark.search.ShapePossibleWatermark

public class PresentationShapePossibleWatermark extends ShapePossibleWatermark<PresentationShape>

Represents possible shape watermark in a PowerPoint document.

Constructors

Constructor	Description
PresentationShapePossibleWatermark(PresentationShape shape, PresentationShapeCollection shapeCollection)

Methods

Method	Description
getParent()	Gets the parent of this `[PresentationShapePossibleWatermark](../../com.groupdocs.watermark.search/presentationshapepossiblewatermark)`.

PresentationShapePossibleWatermark(PresentationShape shape, PresentationShapeCollection shapeCollection)

public PresentationShapePossibleWatermark(PresentationShape shape, PresentationShapeCollection shapeCollection)

Parameters:

Parameter	Type	Description
shape	PresentationShape
shapeCollection	PresentationShapeCollection

getParent()

public ContentPart getParent()

Gets the parent of this [PresentationShapePossibleWatermark](../../com.groupdocs.watermark.search/presentationshapepossiblewatermark).

Returns: ContentPart - The parent of this [PresentationShapePossibleWatermark](../../com.groupdocs.watermark.search/presentationshapepossiblewatermark).

Java: RotateAngleSearchCriteria

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

Inheritance: java.lang.Object, com.groupdocs.watermark.search.SearchCriteria

public class RotateAngleSearchCriteria extends SearchCriteria

Represents criteria allowing filtering by watermark rotate angle.

Learn more:

Searching watermarks

The following example demonstrates how to find and remove watermarks using search criteria.

Watermarker watermarker = new Watermarker(“C:\test.some_ext”); SizeSearchCriteria widthRange = new SizeSearchCriteria(Dimension.Width, 50, 100); RotateAngleSearchCriteria rotateAngle = new RotateAngleSearchCriteria(0, 45); TextSearchCriteria textCriteria = new TextSearchCriteria(Pattern.compile("^Test watermark$"));

PossibleWatermarkCollection watermarks = watermarker.search(textCriteria.and(widthRange.or(rotateAngle))); watermarks.clear();

watermarker.save(“C:\modified_test.some_ext”); watermarker.close();

Constructors

Constructor	Description
RotateAngleSearchCriteria(double minAngle, double maxAngle)	Initializes a new instance of the `[RotateAngleSearchCriteria](../../com.groupdocs.watermark.search/rotateanglesearchcriteria)` class with a starting angle and a ending angle.

Methods

Method	Description
getMinimumAngle()	Gets the starting angle in degrees.
getMaximumAngle()	Gets the ending angle in degrees.
isSatisfiedBy(PossibleWatermark candidate)
accept(ICriteriaVisitor visitor)

RotateAngleSearchCriteria(double minAngle, double maxAngle)

public RotateAngleSearchCriteria(double minAngle, double maxAngle)

Initializes a new instance of the [RotateAngleSearchCriteria](../../com.groupdocs.watermark.search/rotateanglesearchcriteria) class with a starting angle and a ending angle.

Parameters:

Parameter	Type	Description
minAngle	double	The starting angle in degrees.
maxAngle	double	The ending angle in degrees.

getMinimumAngle()

public final double getMinimumAngle()

Gets the starting angle in degrees.

Returns: double - The starting angle.

getMaximumAngle()

public final double getMaximumAngle()

Gets the ending angle in degrees.

Returns: double - The ending angle.

isSatisfiedBy(PossibleWatermark candidate)

public boolean isSatisfiedBy(PossibleWatermark candidate)

Parameters:

Parameter	Type	Description
candidate	PossibleWatermark

Returns: boolean

accept(ICriteriaVisitor visitor)

public void accept(ICriteriaVisitor visitor)

Parameters:

Parameter	Type	Description
visitor	ICriteriaVisitor

Java: SearchCriteria

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

Inheritance: java.lang.Object

public abstract class SearchCriteria

Class that can be used to construct criteria when searching for watermarks.

Methods

Method	Description
and(SearchCriteria other)	Combines this `[SearchCriteria](../../com.groupdocs.watermark.search/searchcriteria)` with other criteria using logical AND operator.
or(SearchCriteria other)	Combines this `[SearchCriteria](../../com.groupdocs.watermark.search/searchcriteria)` with other criteria using logical OR operator.
not()	Negates this `[SearchCriteria](../../com.groupdocs.watermark.search/searchcriteria)`.
isSatisfiedBy(PossibleWatermark candidate)
accept(ICriteriaVisitor visitor)

and(SearchCriteria other)

public final SearchCriteria and(SearchCriteria other)

Combines this [SearchCriteria](../../com.groupdocs.watermark.search/searchcriteria) with other criteria using logical AND operator.

Parameters:

Parameter	Type	Description
other	SearchCriteria	Search criteria to combine with.

Returns: SearchCriteria - Combined search criteria.

or(SearchCriteria other)

public final SearchCriteria or(SearchCriteria other)

Combines this [SearchCriteria](../../com.groupdocs.watermark.search/searchcriteria) with other criteria using logical OR operator.

Parameters:

Parameter	Type	Description
other	SearchCriteria	Search criteria to combine with.

Returns: SearchCriteria - Combined search criteria.

not()

public final SearchCriteria not()

Negates this [SearchCriteria](../../com.groupdocs.watermark.search/searchcriteria).

Returns: SearchCriteria - Combined search criteria.

isSatisfiedBy(PossibleWatermark candidate)

public abstract boolean isSatisfiedBy(PossibleWatermark candidate)

Parameters:

Parameter	Type	Description
candidate	PossibleWatermark

Returns: boolean

accept(ICriteriaVisitor visitor)

public abstract void accept(ICriteriaVisitor visitor)

Parameters:

Parameter	Type	Description
visitor	ICriteriaVisitor

Java: SearchableObjects

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

Inheritance: java.lang.Object

public class SearchableObjects

Specifies document objects that are to be included in a watermark search.

Learn more:

Searching watermarks

Constructors

Constructor	Description
SearchableObjects()	Initializes a new instance of the `[SearchableObjects](../../com.groupdocs.watermark.search/searchableobjects)` class.

Methods

Method	Description
getSpreadsheetSearchableObjects()	Gets the objects inside an Excel document that are to be included in a watermark search.
setSpreadsheetSearchableObjects(int value)	Sets the objects inside an Excel document that are to be included in a watermark search.
getDiagramSearchableObjects()	Gets the objects inside a Visio document that are to be included in a watermark search.
setDiagramSearchableObjects(int value)	Sets the objects inside a Visio document that are to be included in a watermark search.
getPresentationSearchableObjects()	Gets the objects inside a PowerPoint document that are to be included in a watermark search.
setPresentationSearchableObjects(int value)	Sets the objects inside a PowerPoint document that are to be included in a watermark search.
getWordProcessingSearchableObjects()	Gets the objects inside a Word document that are to be included in a watermark search.
setWordProcessingSearchableObjects(int value)	Sets the objects inside a Word document that are to be included in a watermark search.
getPdfSearchableObjects()	Gets the objects inside a PDF document that are to be included in a watermark search.
setPdfSearchableObjects(int value)	Sets the objects inside a PDF document that are to be included in a watermark search.
getEmailSearchableObjects()	Gets the objects inside an email message that are to be included in a watermark search.
setEmailSearchableObjects(int value)	Sets the objects inside an email message that are to be included in a watermark search.

SearchableObjects()

public SearchableObjects()

Initializes a new instance of the [SearchableObjects](../../com.groupdocs.watermark.search/searchableobjects) class.

getSpreadsheetSearchableObjects()

public final int getSpreadsheetSearchableObjects()

Gets the objects inside an Excel document that are to be included in a watermark search.

Returns: int - The objects inside an Excel document that are to be included in a watermark search.

setSpreadsheetSearchableObjects(int value)

public final void setSpreadsheetSearchableObjects(int value)

Sets the objects inside an Excel document that are to be included in a watermark search.

Parameters:

Parameter	Type	Description
value	int	The objects inside an Excel document that are to be included in a watermark search.

getDiagramSearchableObjects()

public final int getDiagramSearchableObjects()

Gets the objects inside a Visio document that are to be included in a watermark search.

Returns: int - The objects inside a Visio document that are to be included in a watermark search.

setDiagramSearchableObjects(int value)

public final void setDiagramSearchableObjects(int value)

Sets the objects inside a Visio document that are to be included in a watermark search.

Parameters:

Parameter	Type	Description
value	int	The objects inside a Visio document that are to be included in a watermark search.

getPresentationSearchableObjects()

public final int getPresentationSearchableObjects()

Gets the objects inside a PowerPoint document that are to be included in a watermark search.

Returns: int - The objects inside a PowerPoint document that are to be included in a watermark search.

setPresentationSearchableObjects(int value)

public final void setPresentationSearchableObjects(int value)

Sets the objects inside a PowerPoint document that are to be included in a watermark search.

Parameters:

Parameter	Type	Description
value	int	The objects inside a PowerPoint document that are to be included in a watermark search.

getWordProcessingSearchableObjects()

public final int getWordProcessingSearchableObjects()

Gets the objects inside a Word document that are to be included in a watermark search.

Returns: int - The objects inside a Word document that are to be included in a watermark search.

setWordProcessingSearchableObjects(int value)

public final void setWordProcessingSearchableObjects(int value)

Sets the objects inside a Word document that are to be included in a watermark search.

Parameters:

Parameter	Type	Description
value	int	The objects inside a Word document that are to be included in a watermark search.

getPdfSearchableObjects()

public final int getPdfSearchableObjects()

Gets the objects inside a PDF document that are to be included in a watermark search.

Returns: int - The objects inside a PDF document that are to be included in a watermark search.

setPdfSearchableObjects(int value)

public final void setPdfSearchableObjects(int value)

Sets the objects inside a PDF document that are to be included in a watermark search.

Parameters:

Parameter	Type	Description
value	int	The objects inside a PDF document that are to be included in a watermark search.

getEmailSearchableObjects()

public final int getEmailSearchableObjects()

Gets the objects inside an email message that are to be included in a watermark search.

Returns: int - The objects inside an email message that are to be included in a watermark search.

setEmailSearchableObjects(int value)

public final void setEmailSearchableObjects(int value)

Sets the objects inside an email message that are to be included in a watermark search.

Parameters:

Parameter	Type	Description
value	int	The objects inside an email message that are to be included in a watermark search.

Java: ShapePossibleWatermark

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

Inheritance: java.lang.Object, com.groupdocs.watermark.search.PossibleWatermark, com.groupdocs.watermark.search.TwoDObjectPossibleWatermark

public abstract class ShapePossibleWatermark<T> extends TwoDObjectPossibleWatermark

Represents shape watermark in a content of any supported format.

T : The type of the shape.

Methods

Method	Description
getRotateAngle()	Gets the rotate angle of the shape in degrees.
getFormattedTextFragments()	Gets the collection of formatted text fragments of the shape.
getText()	Gets the text of the shape.
setText(String value)	Sets the text of the shape.
getImageInternally()
remove()

getRotateAngle()

public double getRotateAngle()

Gets the rotate angle of the shape in degrees.

Returns: double - The rotate angle of the shape in degrees.

getFormattedTextFragments()

public FormattedTextFragmentCollection getFormattedTextFragments()

Gets the collection of formatted text fragments of the shape.

Returns: FormattedTextFragmentCollection - The collection of formatted text fragments of shape.

getText()

public String getText()

Gets the text of the shape.

Returns: java.lang.String - The text of the shape.

setText(String value)

public void setText(String value)

Sets the text of the shape.

Parameters:

Parameter	Type	Description
value	java.lang.String	The text of the shape.

getImageInternally()

public WatermarkableImage getImageInternally()

Returns: WatermarkableImage

remove()

public void remove()

Java: ShapeSearchAdapter

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

Inheritance: java.lang.Object

public abstract class ShapeSearchAdapter

Provides base class for a shape containing specific pieces of document that are to be included in watermark search.

Methods

Method	Description
getPageNumber()
getImageForSearch()
getFormattedTextFragmentsForSearch()
getTextForSearch()
setFoundWatermarkText(String value)
setFoundWatermarkImage(byte[] imageData)

getPageNumber()

public Integer getPageNumber()

Returns: java.lang.Integer

getImageForSearch()

public WatermarkableImage getImageForSearch()

Returns: WatermarkableImage

getFormattedTextFragmentsForSearch()

public FormattedTextFragmentCollection getFormattedTextFragmentsForSearch()

Returns: FormattedTextFragmentCollection

getTextForSearch()

public String getTextForSearch()

Returns: java.lang.String

setFoundWatermarkText(String value)

public void setFoundWatermarkText(String value)

Parameters:

Parameter	Type	Description
value	java.lang.String

setFoundWatermarkImage(byte[] imageData)

public void setFoundWatermarkImage(byte[] imageData)

Parameters:

Parameter	Type	Description
imageData	byte[]

Java: SizeSearchCriteria

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

Inheritance: java.lang.Object, com.groupdocs.watermark.search.SearchCriteria

public class SizeSearchCriteria extends SearchCriteria

Represents criteria allowing filtering by watermark size.

Learn more:

Searching watermarks

The following example demonstrates how to find and remove watermarks using search criteria.

Watermarker watermarker = new Watermarker(“C:\test.some_ext”); SizeSearchCriteria widthRange = new SizeSearchCriteria(Dimension.Width, 50, 100); RotateAngleSearchCriteria rotateAngle = new RotateAngleSearchCriteria(0, 45); TextSearchCriteria textCriteria = new TextSearchCriteria(Pattern.compile("^Test watermark$"));

PossibleWatermarkCollection watermarks = watermarker.search(textCriteria.and(widthRange.or(rotateAngle))); watermarks.clear();

watermarker.save(“C:\modified_test.some_ext”); watermarker.close();

Constructors

Constructor	Description
SizeSearchCriteria(int dimension, double min, double max)	Initializes a new instance of the `[SizeSearchCriteria](../../com.groupdocs.watermark.search/sizesearchcriteria)` class with a specified dimension, a starting value and an ending value.

Methods

Method	Description
getMinimum()	Gets the starting value.
getMaximum()	Gets the ending value.
getDimension()	Gets the dimension of watermark to search by.
isSatisfiedBy(PossibleWatermark candidate)
accept(ICriteriaVisitor visitor)

SizeSearchCriteria(int dimension, double min, double max)

public SizeSearchCriteria(int dimension, double min, double max)

Initializes a new instance of the [SizeSearchCriteria](../../com.groupdocs.watermark.search/sizesearchcriteria) class with a specified dimension, a starting value and an ending value.

Parameters:

Parameter	Type	Description
dimension	int	The dimension `[Dimension](../../com.groupdocs.watermark.common/dimension)` of a watermark to search by.
min	double	The starting value.
max	double	The ending value.

getMinimum()

public final double getMinimum()

Gets the starting value.

Returns: double - The starting value.

getMaximum()

public final double getMaximum()

Gets the ending value.

Returns: double - The ending value.

getDimension()

public final int getDimension()

Gets the dimension of watermark to search by.

Returns: int - The dimension of watermark to search by.

isSatisfiedBy(PossibleWatermark candidate)

public boolean isSatisfiedBy(PossibleWatermark candidate)

Parameters:

Parameter	Type	Description
candidate	PossibleWatermark

Returns: boolean

accept(ICriteriaVisitor visitor)

public void accept(ICriteriaVisitor visitor)

Parameters:

Parameter	Type	Description
visitor	ICriteriaVisitor

Java: SpreadsheetAttachedImagePossibleWatermark

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

Inheritance: java.lang.Object, com.groupdocs.watermark.search.PossibleWatermark, com.groupdocs.watermark.search.AttachedImagePossibleWatermark, com.groupdocs.watermark.search.FloatingAttachedImagePossibleWatermark

public class SpreadsheetAttachedImagePossibleWatermark extends FloatingAttachedImagePossibleWatermark<SpreadsheetAttachment>

Represents possible image watermark in Excel document attachment.

Constructors

Constructor	Description
SpreadsheetAttachedImagePossibleWatermark(SpreadsheetWorksheet worksheet, SpreadsheetAttachment attachment)

SpreadsheetAttachedImagePossibleWatermark(SpreadsheetWorksheet worksheet, SpreadsheetAttachment attachment)

public SpreadsheetAttachedImagePossibleWatermark(SpreadsheetWorksheet worksheet, SpreadsheetAttachment attachment)

Parameters:

Parameter	Type	Description
worksheet	SpreadsheetWorksheet
attachment	SpreadsheetAttachment

Java: SpreadsheetBackgroundPossibleWatermark

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

Inheritance: java.lang.Object, com.groupdocs.watermark.search.PossibleWatermark

public class SpreadsheetBackgroundPossibleWatermark extends PossibleWatermark

Represents possible background watermark in an Excel document.

Constructors

Constructor	Description
SpreadsheetBackgroundPossibleWatermark(SpreadsheetWorksheet worksheet)

Methods

Method	Description
getParent()	Gets the parent of this `[SpreadsheetBackgroundPossibleWatermark](../../com.groupdocs.watermark.search/spreadsheetbackgroundpossiblewatermark)`.
getWidth()	Gets the width of this `[SpreadsheetBackgroundPossibleWatermark](../../com.groupdocs.watermark.search/spreadsheetbackgroundpossiblewatermark)` in pixels.
getHeight()	Gets the height of this `[SpreadsheetBackgroundPossibleWatermark](../../com.groupdocs.watermark.search/spreadsheetbackgroundpossiblewatermark)` in pixels.
getX()	Gets the horizontal offset of this `[SpreadsheetBackgroundPossibleWatermark](../../com.groupdocs.watermark.search/spreadsheetbackgroundpossiblewatermark)` from worksheet left border in pixels.
getY()	Gets the vertical offset of this `[SpreadsheetBackgroundPossibleWatermark](../../com.groupdocs.watermark.search/spreadsheetbackgroundpossiblewatermark)` from worksheet top border in pixels.
getRotateAngle()	Gets the rotate angle of this `[SpreadsheetBackgroundPossibleWatermark](../../com.groupdocs.watermark.search/spreadsheetbackgroundpossiblewatermark)` in degrees.
getUnitOfMeasurement()	Gets the `[UnitOfMeasurement](../../com.groupdocs.watermark.common/unitofmeasurement)` of this `[SpreadsheetBackgroundPossibleWatermark](../../com.groupdocs.watermark.search/spreadsheetbackgroundpossiblewatermark)`.
getImageInternally()
remove()

SpreadsheetBackgroundPossibleWatermark(SpreadsheetWorksheet worksheet)

public SpreadsheetBackgroundPossibleWatermark(SpreadsheetWorksheet worksheet)

Parameters:

Parameter	Type	Description
worksheet	SpreadsheetWorksheet

getParent()

public ContentPart getParent()

Gets the parent of this [SpreadsheetBackgroundPossibleWatermark](../../com.groupdocs.watermark.search/spreadsheetbackgroundpossiblewatermark).

Returns: ContentPart - The parent of this [SpreadsheetBackgroundPossibleWatermark](../../com.groupdocs.watermark.search/spreadsheetbackgroundpossiblewatermark).

getWidth()

public double getWidth()

Gets the width of this [SpreadsheetBackgroundPossibleWatermark](../../com.groupdocs.watermark.search/spreadsheetbackgroundpossiblewatermark) in pixels.

Returns: double - The width of this [SpreadsheetBackgroundPossibleWatermark](../../com.groupdocs.watermark.search/spreadsheetbackgroundpossiblewatermark) in pixels.

getHeight()

public double getHeight()

Gets the height of this [SpreadsheetBackgroundPossibleWatermark](../../com.groupdocs.watermark.search/spreadsheetbackgroundpossiblewatermark) in pixels.

Returns: double - The height of this [SpreadsheetBackgroundPossibleWatermark](../../com.groupdocs.watermark.search/spreadsheetbackgroundpossiblewatermark) in pixels.

getX()

public double getX()

Gets the horizontal offset of this [SpreadsheetBackgroundPossibleWatermark](../../com.groupdocs.watermark.search/spreadsheetbackgroundpossiblewatermark) from worksheet left border in pixels.

Returns: double - The x-coordinate of this [SpreadsheetBackgroundPossibleWatermark](../../com.groupdocs.watermark.search/spreadsheetbackgroundpossiblewatermark).

getY()

public double getY()

Gets the vertical offset of this [SpreadsheetBackgroundPossibleWatermark](../../com.groupdocs.watermark.search/spreadsheetbackgroundpossiblewatermark) from worksheet top border in pixels.

Returns: double - The y-coordinate of this [SpreadsheetBackgroundPossibleWatermark](../../com.groupdocs.watermark.search/spreadsheetbackgroundpossiblewatermark).

getRotateAngle()

public double getRotateAngle()

Gets the rotate angle of this [SpreadsheetBackgroundPossibleWatermark](../../com.groupdocs.watermark.search/spreadsheetbackgroundpossiblewatermark) in degrees.

Returns: double - The rotate angle of this [SpreadsheetBackgroundPossibleWatermark](../../com.groupdocs.watermark.search/spreadsheetbackgroundpossiblewatermark) in degrees.

getUnitOfMeasurement()

public int getUnitOfMeasurement()

Gets the [UnitOfMeasurement](../../com.groupdocs.watermark.common/unitofmeasurement) of this [SpreadsheetBackgroundPossibleWatermark](../../com.groupdocs.watermark.search/spreadsheetbackgroundpossiblewatermark).

Returns: int - The [UnitOfMeasurement](../../com.groupdocs.watermark.common/unitofmeasurement) of this [SpreadsheetBackgroundPossibleWatermark](../../com.groupdocs.watermark.search/spreadsheetbackgroundpossiblewatermark).

getImageInternally()

public WatermarkableImage getImageInternally()

Returns: WatermarkableImage

remove()

public void remove()