AttributeObject

Represents an attribute object.

public class AttributeObject : AttributeType
Public Class AttributeObject
    Inherits AttributeType

Inheritance: ObjectAttributeTypeAttributeObject

Licensing Info

This class is a full DynamicPDF Core Suite feature. One of the following is required for non-evaluation usage:

Examples

The following example shows how to use an attribute object.
Imports System
Imports ceTe.DynamicPDF
Imports ceTe.DynamicPDF.PageElements
  
Module MyModule
  		
    Sub Main()
  		
        ' Create a PDF Document
        Dim MyDocument As Document = New Document 
  		
        ' Specify document as a tagged PDF
        MyDocument.Tag = New TagOptions()
 
        ' Create a page and add it to the document
        Dim MyPage As Page = New Page()
        MyDocument.Pages.Add(MyPage)
 
        ' Create a text area
        Dim MyTextArea As TextArea = New TextArea("This is the text of a TextArea", _
        100, 100, 400, 30,ceTe.DynamicPDF.Font.HelveticaBoldOblique, 18)
 
        ' Create a structure element
        Dim MyStructureElement As StructureElement = New StructureElement(TagType.Paragraph, True)
 
        ' Create an attribute object
        Dim MyAttributeObject As AttributeObject = New AttributeObject(AttributeOwner.Layout)
 
        ' Add attributes to the attribute object
        MyAttributeObject.SetLineHeight() ' Sets default value to the line height attribute
        MyAttributeObject.SetHeight(30) ' Sets specified value to the height attribute 
 
        ' Add attribute object to the structure element
        MyStructureElement.AttributeLists.Add(MyAttributeObject)
 
        ' Tag the text area with the structure element
        MyTextArea.Tag = MyStructureElement
 
        ' Add the text area to the page
        MyPage.Elements.Add(MyTextArea)
  
        ' 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();

        // Specify document as a tagged PDF
        document.Tag = new TagOptions();
		
        // Create a page and add it to the document
        Page page = new Page();
        document.Pages.Add(page);

        // Create a text area
        TextArea textArea = new TextArea("This is the " +"text of a TextArea", 100, 100, 400, 30,
                    ceTe.DynamicPDF.Font.HelveticaBoldOblique, 18);

        // Create a structure element
        StructureElement structureElement = new StructureElement(TagType.Paragraph, true);

        // Create an attribute object
        AttributeObject attributeObject = new AttributeObject(AttributeOwner.Layout);

        // Add attributes to the attribute object
        attributeObject.SetLineHeight(); // Sets default value to the line height attribute
        attributeObject.SetHeight(30); // Sets specified value to the height attribute 

        // Add attribute object to the structure element
        structureElement.AttributeLists.Add(attributeObject);

        // Tag the text area with the structure element
        textArea.Tag = structureElement;

        // Add the text area to the page
        page.Elements.Add(textArea);

        // Save the PDF
        document.Draw( outputPath );
    }
}

Constructors

AttributeObject(AttributeOwner)Initializes a new instance of the AttributeObject class.

Properties

OwnerGets the owner of the attribute object.

Methods

Equals(Object)Determines whether the specified Object is equal to the current Object .
(Inherited from Object)
GetHashCode()Serves as a hash function for a particular type.
(Inherited from Object)
GetType()Gets the Type of the current instance.
(Inherited from Object)
SetAutoGlyphOrientationVertical()Sets a glyph orientation vertical Attribute to the AttributeObject with value auto.
SetAutoGlyphOrientationVertical(Int32)Sets a glyph orientation vertical Attribute to the AttributeObject .
SetAutoHeight()Sets a height Attribute to the AttributeObject with value auto.
SetAutoWidth()Sets a width Attribute to the AttributeObject with value auto.
SetBackgroundColor()Sets a background color Attribute to the AttributeObject with default value.
SetBackgroundColor(RgbColor)Sets a background color Attribute to the AttributeObject .
SetBackgroundColor(Single, Single, Single)Sets a background color Attribute to the AttributeObject .
SetBaselineShift()Sets a baseline shift Attribute to the AttributeObject with default value.
SetBaselineShift(Single)Sets a baseline shift Attribute to the AttributeObject .
SetBlockAlign()Sets a block align Attribute to the AttributeObject with default value.
SetBlockAlign(BlockAlign)Sets a block align Attribute to the AttributeObject .
SetBorderColor()Sets a border color Attribute to the AttributeObject with default value.
SetBorderColor(RgbColor)Sets a border color Attribute to the AttributeObject .
SetBorderColor(RgbColor, RgbColor, RgbColor, RgbColor)Sets a border color Attribute to the AttributeObject .
SetBorderColor(Single, Single, Single)Sets a border color Attribute to the AttributeObject .
SetBorderStyle()Sets a border style Attribute to the AttributeObject with default value.
SetBorderStyle(BorderStyleAttribute)Sets a border style Attribute to the AttributeObject .
SetBorderStyle(BorderStyleAttribute, BorderStyleAttribute, BorderStyleAttribute, BorderStyleAttribute)Sets a border style Attribute to the AttributeObject .
SetBorderThickness()Sets a border thickness Attribute to the AttributeObject with default value.
SetBorderThickness(Single)Sets a border thickness Attribute to the AttributeObject .
SetBorderThickness(Single, Single, Single, Single)Sets a border thickness Attribute to the AttributeObject .
SetBoundingBox()Sets a bounding box Attribute to the AttributeObject with default value.
SetBoundingBox(BoundingBox)Sets a bounding box Attribute to the AttributeObject .
SetBoundingBox(Single, Single, Single, Single)Sets a bounding box Attribute to the AttributeObject .
SetChecked()Sets a checked Attribute to the AttributeObject with default value.
SetChecked(Checked)Sets a checked Attribute to the AttributeObject .
SetColor()Sets a color Attribute to the AttributeObject with default value.
SetColor(RgbColor)Sets a color Attribute to the AttributeObject .
SetColor(Single, Single, Single)Sets a color Attribute to the AttributeObject .
SetColumnCount()Sets a column count Attribute to the AttributeObject with default value.
SetColumnCount(Int32)Sets a column count Attribute to the AttributeObject .
SetColumnGap()Sets a column gap Attribute to the AttributeObject with default value.
SetColumnGap(Single)Sets a column gap Attribute to the AttributeObject .
SetColumnGap(Single[])Sets a column gap Attribute to the AttributeObject .
SetColumnSpan()Sets a column span Attribute to the AttributeObject with default value.
SetColumnSpan(Int32)Sets a column span Attribute to the AttributeObject .
SetColumnWidths()Sets a column widths Attribute to the AttributeObject with default value.
SetColumnWidths(Single)Sets a column widths Attribute to the AttributeObject .
SetColumnWidths(Single[])Sets a column widths Attribute to the AttributeObject .
SetDescription(String)Sets a description Attribute to the AttributeObject .
SetEndIndent()Sets a end indent Attribute to the AttributeObject with default value.
SetEndIndent(Single)Sets a end indent Attribute to the AttributeObject .
SetGlyphOrientationVertical()Sets a glyph orientation vertical Attribute to the AttributeObject with default value.
SetHeaders()Sets a headers Attribute to the AttributeObject with default value.
SetHeaders(String[])Sets a headers Attribute to the AttributeObject .
SetHeight()Sets a height Attribute to the AttributeObject with default value.
SetHeight(Single)Sets a height Attribute to the AttributeObject .
SetInlineAlign()Sets a inline align Attribute to the AttributeObject with default value.
SetInlineAlign(InlineAlign)Sets a inline align Attribute to the AttributeObject .
SetLineHeight()Sets a line height Attribute to the AttributeObject with default value.
SetLineHeight(LineHeight)Sets a line height Attribute to the AttributeObject .
SetLineHeight(Single)Sets a line height Attribute to the AttributeObject .
SetListNumbering()Sets a list numbering Attribute to the AttributeObject with default value.
SetListNumbering(ListNumbering)Sets a list numbering Attribute to the AttributeObject .
SetPadding()Sets a padding Attribute to the AttributeObject with default value.
SetPadding(Single)Sets a padding Attribute to the AttributeObject .
SetPadding(Single, Single, Single, Single)Sets a padding Attribute to the AttributeObject .
SetPlacement()Sets a placement Attribute to the AttributeObject with default value.
SetPlacement(Placement)Sets a placement Attribute to the AttributeObject .
SetRole(Role)Sets a role Attribute to the AttributeObject .
SetRowSpan()Sets a row span Attribute to the AttributeObject with default value.
SetRowSpan(Int32)Sets a row span Attribute to the AttributeObject .
SetRubyAlign()Sets a ruby align Attribute to the AttributeObject with default value.
SetRubyAlign(RubyAlign)Sets a ruby align Attribute to the AttributeObject .
SetRubyPosition()Sets a ruby position Attribute to the AttributeObject with default value.
SetRubyPosition(RubyPosition)Sets a ruby positon Attribute to the AttributeObject .
SetScope()Sets a scope Attribute to the AttributeObject with default value.
SetScope(Scope)Sets a scope Attribute to the AttributeObject .
SetSpaceAfter()Sets a space after Attribute to the AttributeObject with default value.
SetSpaceAfter(Single)Sets a space after Attribute to the AttributeObject .
SetSpaceBefore()Sets a space before Attribute to the AttributeObject with default value.
SetSpaceBefore(Single)Sets a space before Attribute to the AttributeObject .
SetStartIndent()Sets a start indent Attribute to the AttributeObject with default value.
SetStartIndent(Single)Sets a start indent Attribute to the AttributeObject .
SetSummary(String)Sets a summary Attribute to the AttributeObject .
SetTableCellBorderStyle()Sets a table cell border style Attribute to the AttributeObject with default value.
SetTableCellBorderStyle(BorderStyleAttribute)Sets a table cell border style Attribute to the AttributeObject .
SetTableCellBorderStyle(BorderStyleAttribute, BorderStyleAttribute, BorderStyleAttribute, BorderStyleAttribute)Sets a table cell border style Attribute to the AttributeObject .
SetTableCellPadding()Sets a table cell padding Attribute to the AttributeObject with default value.
SetTableCellPadding(Single)Sets a table cell padding Attribute to the AttributeObject .
SetTableCellPadding(Single, Single, Single, Single)Sets a table cell padding Attribute to the AttributeObject .
SetTextAlign()Sets a text align Attribute to the AttributeObject with default value.
SetTextAlign(TextAlignAttribute)Sets a text align Attribute to the AttributeObject .
SetTextDecorationColor()Sets a text decoration color Attribute to the AttributeObject with default value.
SetTextDecorationColor(RgbColor)Sets a text decoration color Attribute to the AttributeObject .
SetTextDecorationColor(Single, Single, Single)Sets a text decoration color Attribute to the AttributeObject .
SetTextDecorationThickness()Sets a text decoration thickness Attribute to the AttributeObject with default value.
SetTextDecorationThickness(Single)Sets a text decoration thickness Attribute to the AttributeObject .
SetTextDecorationType()Sets a text decoration type Attribute to the AttributeObject with default value.
SetTextDecorationType(TextDecorationType)Sets a text decoration type Attribute to the AttributeObject .
SetTextIndent()Sets a text indent Attribute to the AttributeObject with default value.
SetTextIndent(Single)Sets a text indent Attribute to the AttributeObject .
SetWidth()Sets a width Attribute to the AttributeObject with default value.
SetWidth(Single)Sets a width Attribute to the AttributeObject .
SetWritingMode()Sets a writing mode Attribute to the AttributeObject with default value.
SetWritingMode(WritingMode)Sets a writing mode Attribute to the AttributeObject .
ToString()Returns a String that represents the current Object .
(Inherited from Object)

See Also

ceTe.DynamicPDF

In this topic