TransparencyGroup
Represents a group of page elements that will have transparency.
public class TransparencyGroup : Group, IEnumerable, IPageElementContainer, ISerializable
Public Class TransparencyGroup
Inherits Group
Implements IEnumerable, IPageElementContainer, ISerializable
Inheritance: ObjectPageElementGroupTransparencyGroup
Implements: IEnumerable, IPageElementContainer, ISerializable
Licensing Info
This class is a full DynamicPDF Core Suite feature. One of the following is required for non-evaluation usage:
- An active DynamicPDF Ultimate Subscription
- An active DynamicPDF Professional or Professional Plus Subscription with DynamicPDF Core Suite selected.
- A DynamicPDF Core Suite for .NET v12.X Developer License.
Examples
The following example will display text with a transparent rectangle over it. The text will be visible beneath the rectangle.Imports System
Imports ceTe.DynamicPDF
Imports ceTe.DynamicPDF.PageElements
Module MyModule
Sub Main()
' Create a PDF Document
Dim MyDocument As Document = New Document
' Create a Page and add it to the document
Dim MyPage As Page = New Page
MyDocument.Pages.Add(MyPage)
' Create a transparency group and add a rectangle to it
Dim MyGroup As TransparencyGroup = New TransparencyGroup(0.5F)
MyGroup.Add(New Rectangle(50, 0, 100, 100, RgbColor.Red, RgbColor.Red))
' Add a label to the page
MyPage.Elements.Add(New Label("This text is beneath the rectangle.", 0, 0, 200, 12))
'Add the transparency group to the page
MyPage.Elements.Add(MyGroup)
' Save the PDF
MyDocument.Draw("C:\MyDocument.pdf")
End Sub
End Module
using System;
using ceTe.DynamicPDF;
using ceTe.DynamicPDF.PageElements;
public class Example
{
public static void CreatePDF(string outputPath)
{
// Create a PDF Document
Document document = new Document();
// Create a Page and add it to the document
Page page = new Page();
document.Pages.Add( page );
// Create a transparency group and add a rectangle to it
TransparencyGroup group1 = new TransparencyGroup( 0.5f );
group1.Add( new Rectangle( 50, 0, 100, 100, RgbColor.Red, RgbColor.Red ) );
// Add a label to the page
page.Elements.Add( new Label( "This text is beneath the rectangle.", 0, 0, 200, 12 ) );
// Add the transparency group to the page
page.Elements.Add( group1 );
// Save the PDF
document.Draw( outputPath );
}
}
Remarks
This class can be used to add transparency to page elements. Any page element that is placed in this group will be displayed with the transparency values and attributes of this group.
Constructors
TransparencyGroup(Single) | Initializes a new instance of the TransparencyGroup class. |
TransparencyGroup(Single, BlendMode) | Initializes a new instance of the TransparencyGroup class. |
Properties
BlendMode | Gets or sets the blend mode value. |
Count | Gets the number of page elements in the group. (Inherited from Group) |
FillAlpha | Gets or sets the fill alpha value. |
ID | Gets or sets the ID of the page element. (Inherited from PageElement) |
IgnoreMargins | Gets or sets ignore margin property. Setting false will consider the margin while placing the page element based on the RelativeTo property. (Inherited from PageElement) |
Item[Int32] | Gets the PageElement object at the given index. (Inherited from Group) |
Item[String] | Gets the PageElement object with the given ID. (Inherited from Group) |
RelativeTo | Gets and sets placement of the page element on the page. (Inherited from PageElement) |
StrokeAlpha | Gets or sets the stroke alpha value. |
Methods
Add(PageElement) | Adds a page element to the group. (Inherited from Group) |
Draw(PageWriter) | Draws the transparency group to the given PageWriter object. |
Equals(Object) | Determines whether the specified Object is equal to the current Object . (Inherited from Object) |
GetEnumerator() | Returns an enumerator that can iterate through the Group . (Inherited from Group) |
GetHashCode() | Serves as a hash function for a particular type. (Inherited from Object) |
GetPageElementByID(String) | Returns a page element with the given ID. (Inherited from Group) |
GetType() | Gets the Type of the current instance. (Inherited from Object) |
Insert(Int32, PageElement) | Inserts a page element to the group. (Inherited from Group) |
ToString() | Returns a String that represents the current Object . (Inherited from Object) |