SetText

SetText(string)

Adds Text watermark into the document.

public void SetText(string text)
ParameterTypeDescription
textStringText that is displayed as a watermark.

Exceptions

exceptioncondition
ArgumentOutOfRangeExceptionThrows when the text length is out of range or the text contains only whitespaces.
ArgumentNullExceptionThrows when the text is null.

Remarks

The text length must be in the range from 1 to 200 inclusive. The text cannot be null or contain only whitespaces.

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();

See Also

SetText(string, TextWatermarkOptions)

Adds Text watermark into the document.

public void SetText(string text, TextWatermarkOptions options)
ParameterTypeDescription
textStringText that is displayed as a watermark.
optionsTextWatermarkOptionsDefines additional options for the text watermark.

Exceptions

exceptioncondition
ArgumentOutOfRangeExceptionThrows when the text length is out of range or the text contain only whitespaces.
ArgumentNullExceptionThrows when the text is null.

Remarks

The text length must be in the range from 1 to 200 inclusive. The text cannot be null or contain only whitespaces.

If TextWatermarkOptions is null, the watermark will be set with default options.

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();

See Also

Watermark.SetImage