Highlight Object Attributes

 

Additional to the Common Attributes, this object has the following attributes:

Attribute Name

Description

Type

Values

Default Value

Left

Left position in Twips

Integer

 

0

Top

Top position in Twips

Integer

 

0

Right

Right position in Twips

Integer

 

0

Bottom

Bottom position in Twips

Integer

 

0

LeftF

Left position in Twips

Float

 

0.00F

TopF

Top position in Twips

Float

 

0.00F

RightF

Right position in Twips

Float

 

0.00F

BottomF

Bottom position in Twips

Float

 

0.00F

Page

Page Index where object is located.  Page Number is Page Index + 1.

Integer

>= 0

0

Locked

Object cannot be modified. This proprietary PDF Creator attribute works only with PDF Creator and files saved in Design or ViewAndDesign modes.

Boolean

True / False

False

Note Left

Left position in Twips.

Integer

 

NULL

Note Top

Top position in Twips.

Integer

 

NULL

Note Right

Right position in Twips.

Integer

 

3000

Note Bottom

Bottom position in Twips.

Integer

 

2000

Highlight Left

Left position in Twips.

Integer

 

0

Highlight Right

Right position in Twips.

Integer

 

0

Highlight Top

Top position in Twips.

Integer

 

0

Highlight Bottom

Bottom position in Twips.

Integer

 

0

Visible

Object is visible when document is printed

Boolean

True / False

True

Editable

Standard PDF attribute that makes the object editable or not in any viewer.

Boolean

True / False

True

Author

Name of the person creating the note/document.

String

 

NULL

Open

Sets open/closed state of the sticky note.

Boolean

True / False

False

BorderColor

Color for drawing text border.

Color

COLORREF (bbggrr) 000000 to FFFFFF

or in COLORREF (aabbggrr) 00000000 to FFFFFFFF

000000 (Solid black)

BorderWidth

Width of border around text.

enum IacBorderwidth

Units are in points or 12th of an inch.

0: acBorderWidthNone

1: acBorderWidthSimple

2: acBorderWidthDouble

3: acBorderWidthTriple

4: acBorderWidthQuadruple

1: acBorderWidthSimple

Text

String of text contained in object.

String

 

NULL

TextFont

Font name and style for drawing text.

Font

String in the form of: FontName, FontSize, Weight, Italic, Underline

NULL

TextColor

Color for drawing text.

Color

COLORREF (bbggrr) 000000 to FFFFFF

or in COLORREF (aabbggrr) 00000000 to FFFFFFFF

000000 (Solid black)

BackColor

Color for filling the background of Text object.

Color

COLORREF (bbggrr) 000000 to FFFFFF

COLORREF (aabbggrr) 00000000 to FFFFFFFF

FF00FFFF (Solid Yellow)

TitleFont

Font name and style for drawing title text.

Font

String in the form of: FontName,FontSize, Weight, Italic,Underline

NULL

TitleHeight

Height of title space in Twips.

Integer

 

300

CanActivate

User can Activate.

Boolean

True/False

True

Hidden

Hidden in certain report states

Integer

A binary combination of the following values:

1: Hidden in Run mode

2: Hidden in Design mode

4: Reserved value

8: Hidden in Print preview

16: Hidden in Annotation mode

0: Always visible

Annotation

Object is saved as an annotation as opposed to a drawing within the page contents

Boolean

True / False

False for static objects such as lines, polygons and text. True for dynamic objects such as form fields or high-lighters

LayerID

ID layer which belongs the object.

String

   

Opacity

Object' s image will be rendered in the case of using GDI+ or DirectX with varying range of translucency

Integer

1 (most translucent) to 100 (most opaque)

100

BlendMode  

Blends the color object according to a define mode. This blending is also applied to the object when it is saved or printed.

enum IacBlendMode

0: acBlendModeNormal

1: acBlendModeMultiply

2: acBlendModeScreen

3: acBlendModeOverlay

4 : acBlendModeDarken

5: acBlendModeLighten

6: acBlendModeColorDodge

7: acBlendModeColorBurn

8: acBlendModeHardLight

9: acBlendModeSoftLight

10: acBlendModeDifference

11: acBlendModeExclusion

12 : acBlendModeHue

13: acBlendModeSaturation

14 : acBlendModeColor

15: acBlendModeLuminosity

16: acBlendModeCompatible

0: acBlendModeNormal

 

Example

Public Sub Sample()

    ' Constants for Activation codes

    Const strLicenseTo As String = "Amyuni PDF Creator .NET Evaluation"

    Const strActivationCode As String = "07EFCDAB0100010025C3B7B351579FF94C49112EAF7368612744C7237C2F6A215A53E83A9ECCFFE54C52063CB05338BDE555773D7B1B"

 

    ' Initialize library

    ' This should be done once

    acPDFCreatorLib.Initialize()

 

    ' set license key This is needed only with licensed version

    acPDFCreatorLib.SetLicenseKey(strLicenseTo, strActivationCode)

 

    ' Create a new PDF document

    Dim doc As New Amyuni.PDFCreator.IacDocument()

 

    ' Create page object

    Dim page As Amyuni.PDFCreator.IacPage

 

    ' Define first page of PDF document

    page = doc.GetPage(1)

 

    ' Switch to design mode before adding objects to the document

    doc.ReportState = Amyuni.PDFCreator.IacReportState.acReportStateDesign

 

    ' Create a Highlight

    With page.CreateObject(Amyuni.PDFCreator.IacObjectType.acObjectTypeHighlight, "Highlight1")

        ' General Attributes

        .Attribute("Left").Value = 1000        

        .Attribute("Right").Value = 3250

        .Attribute("Top").Value = 0

        .Attribute("Bottom").Value = 500

        ' Highlight Attributes

        .Attribute("Text").Value = "Amyuni Technologies"

        .Attribute("Note Left").Value = 50

        .Attribute("Highlight Left").Value = 100

        .Attribute("Highlight Right").Value = 1000

        .Attribute("Highlight Top").Value = 100

        .Attribute("Highlight Bottom").Value = 1000

        .Attribute("BackColor").Value = &HFFFF

    End With

 

    ' Refresh the PDF document

    doc.Refresh()

 

    ' Switch to run mode after objects to the document

    doc.ReportState = Amyuni.PDFCreator.IacReportState.acReportStateRun

 

    ' Create new stream object

    Dim fileWrite As System.IO.Stream = System.IO.File.OpenWrite("C:\temp\CreatePDFDocument_resulting.pdf")

 

    ' Save stream

    doc.Save(fileWrite, Amyuni.PDFCreator.IacFileSaveOption.acFileSaveView)

 

    ' Close the stream

    fileWrite.Close()

 

    ' terminate library to free resources

    acPDFCreatorLib.Terminate()

 

    ' destroy objects

    doc.Dispose()

    page.Dispose()

End Sub

public void Sample()

{

    // Constants for Activation codes

    const string strLicenseTo = "Amyuni PDF Creator .NET Evaluation";

    const string strActivationCode = "07EFCDAB0100010025C3B7B351579FF94C49112EAF7368612744C7237C2F6A215A53E83A9ECCFFE54C52063CB05338BDE555773D7B1B";

 

    // Initialize library

    // This should be done once

    acPDFCreatorLib.Initialize();

 

    // set license key This is needed only with licensed version

    acPDFCreatorLib.SetLicenseKey(strLicenseTo, strActivationCode);

 

    // Create a new PDF document

    Amyuni.PDFCreator.IacDocument doc = new Amyuni.PDFCreator.IacDocument();

 

    // Create page object

    Amyuni.PDFCreator.IacPage page;

 

    // Define first page of PDF document

    page = doc.GetPage(1);

 

    // Switch to design mode before adding objects to the document

    doc.ReportState = Amyuni.PDFCreator.IacReportState.acReportStateDesign;

 

    // ' Create a Highlight

    using (Amyuni.PDFCreator.IacObject oText = page.CreateObject(Amyuni.PDFCreator.IacObjectType.acObjectTypeHighlight, "Highlight1"))

    {

        // General Attributes

        oText.Attribute("Left").Value = 1000;        

        oText.Attribute("Right").Value = 3250;

        oText.Attribute("Top").Value = 0;

        oText.Attribute("Bottom").Value = 500;

        // Highlight Attributes

        oText.Attribute("Text").Value = "Amyuni Technologies";

        oText.Attribute("Note Left").Value = 50;

        oText.Attribute("Highlight Left").Value = 100;

        oText.Attribute("Highlight Right").Value = 1000;

        oText.Attribute("Highlight Top").Value = 100;

        oText.Attribute("Highlight Bottom").Value = 1000;

        oText.Attribute("BackColor").Value = 0xFFFF;

    }

 

    // Switch to run mode after objects to the document

    doc.ReportState = Amyuni.PDFCreator.IacReportState.acReportStateRun;

 

    // Create new stream object

    System.IO.FileStream fileWrite = new System.IO.FileStream(@"C:\temp\CreatePDFDocument_resulting.pdf",

            System.IO.FileMode.Create,

            System.IO.FileAccess.Write,

            System.IO.FileShare.Read);

 

    // Save stream

    doc.Save(fileWrite, Amyuni.PDFCreator.IacFileSaveOption.acFileSaveView);

 

    // Close the stream

    fileWrite.Close();

 

    // terminate library to free resources

    acPDFCreatorLib.Terminate();

 

    // destroy objects

    doc.Dispose();

    page.Dispose();

}