Class TextWatermarkOptions
Class TextWatermarkOptions
Namespace: Aspose.Words
Assembly: Aspose.Words.dll (25.12.0)
Contains options that can be specified when adding a watermark with text.
To learn more, visit the Working with Watermark documentation article.
public class TextWatermarkOptionsInheritance
Inherited Members
object.GetType() , object.MemberwiseClone() , object.ToString() , object.Equals(object?) , object.Equals(object?, object?) , object.ReferenceEquals(object?, object?) , object.GetHashCode()
Examples
Shows how to create a text watermark.
Document doc = new Document();
// Add a plain text watermark.
doc.Watermark.SetText("Aspose Watermark");
// If we wish to edit the text formatting using it as a watermark,
// we can do so by passing a TextWatermarkOptions object when creating the watermark.
TextWatermarkOptions textWatermarkOptions = new TextWatermarkOptions();
textWatermarkOptions.FontFamily = "Arial";
textWatermarkOptions.FontSize = 36;
textWatermarkOptions.Color = Color.Black;
textWatermarkOptions.Layout = WatermarkLayout.Diagonal;
textWatermarkOptions.IsSemitrasparent = false;
doc.Watermark.SetText("Aspose Watermark", textWatermarkOptions);
doc.Save(ArtifactsDir + "Document.TextWatermark.docx");
// We can remove a watermark from a document like this.
if (doc.Watermark.Type == WatermarkType.Text)
doc.Watermark.Remove();Constructors
TextWatermarkOptions()
public TextWatermarkOptions()Properties
Color
Gets or sets font color. The default value is System.Drawing.Color.Silver.
public Color Color { get; set; }Property Value
Examples
Shows how to create a text watermark.
Document doc = new Document();
// Add a plain text watermark.
doc.Watermark.SetText("Aspose Watermark");
// If we wish to edit the text formatting using it as a watermark,
// we can do so by passing a TextWatermarkOptions object when creating the watermark.
TextWatermarkOptions textWatermarkOptions = new TextWatermarkOptions();
textWatermarkOptions.FontFamily = "Arial";
textWatermarkOptions.FontSize = 36;
textWatermarkOptions.Color = Color.Black;
textWatermarkOptions.Layout = WatermarkLayout.Diagonal;
textWatermarkOptions.IsSemitrasparent = false;
doc.Watermark.SetText("Aspose Watermark", textWatermarkOptions);
doc.Save(ArtifactsDir + "Document.TextWatermark.docx");
// We can remove a watermark from a document like this.
if (doc.Watermark.Type == WatermarkType.Text)
doc.Watermark.Remove();FontFamily
Gets or sets font family name. The default value is “Calibri”.
public string FontFamily { get; set; }Property Value
Examples
Shows how to create a text watermark.
Document doc = new Document();
// Add a plain text watermark.
doc.Watermark.SetText("Aspose Watermark");
// If we wish to edit the text formatting using it as a watermark,
// we can do so by passing a TextWatermarkOptions object when creating the watermark.
TextWatermarkOptions textWatermarkOptions = new TextWatermarkOptions();
textWatermarkOptions.FontFamily = "Arial";
textWatermarkOptions.FontSize = 36;
textWatermarkOptions.Color = Color.Black;
textWatermarkOptions.Layout = WatermarkLayout.Diagonal;
textWatermarkOptions.IsSemitrasparent = false;
doc.Watermark.SetText("Aspose Watermark", textWatermarkOptions);
doc.Save(ArtifactsDir + "Document.TextWatermark.docx");
// We can remove a watermark from a document like this.
if (doc.Watermark.Type == WatermarkType.Text)
doc.Watermark.Remove();FontSize
Gets or sets a font size. The default value is 0 - auto.
public float FontSize { get; set; }Property Value
Examples
Shows how to create a text watermark.
Document doc = new Document();
// Add a plain text watermark.
doc.Watermark.SetText("Aspose Watermark");
// If we wish to edit the text formatting using it as a watermark,
// we can do so by passing a TextWatermarkOptions object when creating the watermark.
TextWatermarkOptions textWatermarkOptions = new TextWatermarkOptions();
textWatermarkOptions.FontFamily = "Arial";
textWatermarkOptions.FontSize = 36;
textWatermarkOptions.Color = Color.Black;
textWatermarkOptions.Layout = WatermarkLayout.Diagonal;
textWatermarkOptions.IsSemitrasparent = false;
doc.Watermark.SetText("Aspose Watermark", textWatermarkOptions);
doc.Save(ArtifactsDir + "Document.TextWatermark.docx");
// We can remove a watermark from a document like this.
if (doc.Watermark.Type == WatermarkType.Text)
doc.Watermark.Remove();Remarks
Valid values range from 0 to 65.5 inclusive.
Auto font size means that the watermark will be scaled to its max width and max height relative to the page margins.
Exceptions
Throws when argument was out of the range of valid values.
IsSemitrasparent
Gets or sets a boolean value which is responsible for opacity of the watermark.
The default value is true.
public bool IsSemitrasparent { get; set; }Property Value
Examples
Shows how to create a text watermark.
Document doc = new Document();
// Add a plain text watermark.
doc.Watermark.SetText("Aspose Watermark");
// If we wish to edit the text formatting using it as a watermark,
// we can do so by passing a TextWatermarkOptions object when creating the watermark.
TextWatermarkOptions textWatermarkOptions = new TextWatermarkOptions();
textWatermarkOptions.FontFamily = "Arial";
textWatermarkOptions.FontSize = 36;
textWatermarkOptions.Color = Color.Black;
textWatermarkOptions.Layout = WatermarkLayout.Diagonal;
textWatermarkOptions.IsSemitrasparent = false;
doc.Watermark.SetText("Aspose Watermark", textWatermarkOptions);
doc.Save(ArtifactsDir + "Document.TextWatermark.docx");
// We can remove a watermark from a document like this.
if (doc.Watermark.Type == WatermarkType.Text)
doc.Watermark.Remove();Layout
Gets or sets layout of the watermark. The default value is Aspose.Words.WatermarkLayout.Diagonal.
public WatermarkLayout Layout { get; set; }Property Value
Examples
Shows how to create a text watermark.
Document doc = new Document();
// Add a plain text watermark.
doc.Watermark.SetText("Aspose Watermark");
// If we wish to edit the text formatting using it as a watermark,
// we can do so by passing a TextWatermarkOptions object when creating the watermark.
TextWatermarkOptions textWatermarkOptions = new TextWatermarkOptions();
textWatermarkOptions.FontFamily = "Arial";
textWatermarkOptions.FontSize = 36;
textWatermarkOptions.Color = Color.Black;
textWatermarkOptions.Layout = WatermarkLayout.Diagonal;
textWatermarkOptions.IsSemitrasparent = false;
doc.Watermark.SetText("Aspose Watermark", textWatermarkOptions);
doc.Save(ArtifactsDir + "Document.TextWatermark.docx");
// We can remove a watermark from a document like this.
if (doc.Watermark.Type == WatermarkType.Text)
doc.Watermark.Remove();