GdPicture.NET.14
GdPicture14 Namespace / GdPicturePDF Class / SetTagAttribute Method / SetTagAttribute(Int32,String,Double) Method
A unique tag identifier of the tag's tree element to which the new attribute will be attached.
A name of the newly defined attribute to be attached to the specified tag's tree element.
A value of the newly defined attribute as a number, that is to be attached to the specified tag's tree element.
Example





In This Topic
SetTagAttribute(Int32,String,Double) Method
In This Topic
Creates a new attribute for a structure element (tag) specified by its unique (tag's) identifier, that is a part of the document's tag structure tree related to the currently loaded PDF document.

This attribute consists of a key-value pair: the key is the attribute's name and the value is the attribute's corresponding value. You are allowed to set the attribute's value as a number using this method.

Syntax
'Declaration
 

Public Overloads Function SetTagAttribute( _
   ByVal TagID As Integer, _
   ByVal Key As String, _
   ByVal Value As Double _
) As GdPictureStatus
public GdPictureStatus SetTagAttribute( 
   int TagID,
   string Key,
   double Value
)
public function SetTagAttribute( 
    TagID: Integer;
    Key: String;
    Value: Double
): GdPictureStatus; 
public function SetTagAttribute( 
   TagID : int,
   Key : String,
   Value : double
) : GdPictureStatus;
public: GdPictureStatus SetTagAttribute( 
   int TagID,
   string* Key,
   double Value
) 
public:
GdPictureStatus SetTagAttribute( 
   int TagID,
   String^ Key,
   double Value
)

Parameters

TagID
A unique tag identifier of the tag's tree element to which the new attribute will be attached.
Key
A name of the newly defined attribute to be attached to the specified tag's tree element.
Value
A value of the newly defined attribute as a number, that is to be attached to the specified tag's tree element.

Return Value

A member of the GdPictureStatus enumeration. If the method has been successfully followed, then the return value is GdPictureStatus.OK.

We strongly recommend always checking this status first.

Remarks
This method is only allowed for use with non-encrypted documents.
Example
How to set attributes to a newly created tag attached to the underlined text. 
Dim caption As String = "Example: SetTagAttribute"
Using gdpicturePDF As GdPicturePDF = New GdPicturePDF()
    If (gdpicturePDF.NewPDF(PdfConformance.PDF_UA_1) = GdPictureStatus.OK) AndAlso
       (gdpicturePDF.NewPage(PdfPageSizes.PdfPageSizeA4) = GdPictureStatus.OK) Then
        'This is required to have a valid PDF_UA document.
        gdpicturePDF.SetTitle("My first PDF/UA document")
        Dim fontResName As String = gdpicturePDF.AddTrueTypeFontU("Arial", False, False, True)
        If (gdpicturePDF.GetStat() = GdPictureStatus.OK) AndAlso
           (gdpicturePDF.SetFillColor(Color.Blue) = GdPictureStatus.OK) AndAlso
           (gdpicturePDF.SetTextSize(20) = GdPictureStatus.OK) Then
            Dim tagRootID As Integer = gdpicturePDF.GetTagRootID()
            If (gdpicturePDF.GetStat() = GdPictureStatus.OK) AndAlso
               (gdpicturePDF.SetLanguage("en-US") = GdPictureStatus.OK) Then
                Dim tagParagraph As Integer = gdpicturePDF.NewTag(tagRootID, "P")
                If (gdpicturePDF.GetStat() = GdPictureStatus.OK) AndAlso
                   (gdpicturePDF.SetTagAttribute(tagParagraph, "TextDecorationType", "Underline") = GdPictureStatus.OK) AndAlso
                   (gdpicturePDF.SetTagAttribute(tagParagraph, "LineHeight", 20) = GdPictureStatus.OK) Then
                    If (gdpicturePDF.BeginMarkedContentSequence(tagParagraph, "P") = GdPictureStatus.OK) AndAlso
                       (gdpicturePDF.DrawTextUnderline(fontResName, 20, 700, "This is underlined text in english that is tagged as paragraph!", Color.Aquamarine, 3) = GdPictureStatus.OK) AndAlso
                       (gdpicturePDF.EndMarkedContent() = GdPictureStatus.OK) Then
                        Dim status As GdPictureStatus = gdpicturePDF.SaveToFile("test_tagged.pdf")
                        If status = GdPictureStatus.OK Then
                            MessageBox.Show("Your new PDF document has been successfully created.", caption)
                        Else
                            MessageBox.Show("The file can't be saved. Status: " + status.ToString(), caption)
                        End If
                    Else
                        MessageBox.Show("Creating a tag's content has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption)
                    End If
                Else
                    MessageBox.Show("The NewTag() or SetTagAttribute() methods have failed with the status: " + gdpicturePDF.GetStat().ToString(), caption)
                End If
            Else
                MessageBox.Show("Getting the root or setting the language has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption)
            End If
        Else
            MessageBox.Show("Setting text properties has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption)
        End If
        gdpicturePDF.CloseDocument()
    Else
        MessageBox.Show("The new document can't be created. Status: " + gdpicturePDF.GetStat().ToString(), caption)
    End If
End Using
string caption = "Example: SetTagAttribute";
using (GdPicturePDF gdpicturePDF = new GdPicturePDF())
{
    if ((gdpicturePDF.NewPDF(PdfConformance.PDF_UA_1) == GdPictureStatus.OK) &&
        (gdpicturePDF.NewPage(PdfPageSizes.PdfPageSizeA4) == GdPictureStatus.OK))
    {
        //This is required to have a valid PDF_UA document.
        gdpicturePDF.SetTitle("My first PDF/UA document");
        string fontResName = gdpicturePDF.AddTrueTypeFontU("Arial", false, false, true);
        if ((gdpicturePDF.GetStat() == GdPictureStatus.OK) &&
            (gdpicturePDF.SetFillColor(Color.Blue) == GdPictureStatus.OK) &&
            (gdpicturePDF.SetTextSize(20) == GdPictureStatus.OK))
        {
            int tagRootID = gdpicturePDF.GetTagRootID();
            if ((gdpicturePDF.GetStat() == GdPictureStatus.OK) &&
                (gdpicturePDF.SetLanguage("en-US") == GdPictureStatus.OK))
            {
                int tagParagraph = gdpicturePDF.NewTag(tagRootID, "P");
                if ((gdpicturePDF.GetStat() == GdPictureStatus.OK) &&
                    (gdpicturePDF.SetTagAttribute(tagParagraph, "TextDecorationType", "Underline") == GdPictureStatus.OK) &&
                    (gdpicturePDF.SetTagAttribute(tagParagraph, "LineHeight", 20) == GdPictureStatus.OK))
                {
                    if ((gdpicturePDF.BeginMarkedContentSequence(tagParagraph, "P") == GdPictureStatus.OK) &&
                        (gdpicturePDF.DrawTextUnderline(fontResName, 20, 700, "This is underlined text in english that is tagged as paragraph!", Color.Aquamarine, 3) == GdPictureStatus.OK) &&
                        (gdpicturePDF.EndMarkedContent() == GdPictureStatus.OK))
                    {
                        GdPictureStatus status = gdpicturePDF.SaveToFile("test_tagged.pdf");
                        if (status == GdPictureStatus.OK)
                            MessageBox.Show("Your new PDF document has been successfully created.", caption);
                        else
                            MessageBox.Show("The file can't be saved. Status: " + status.ToString(), caption);
                    }
                    else
                        MessageBox.Show("Creating a tag's content has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption);
                }
                else
                    MessageBox.Show("The NewTag() or SetTagAttribute() methods have failed with the status: " + gdpicturePDF.GetStat().ToString(), caption);
            }
            else
                MessageBox.Show("Getting the root or setting the language has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption);
        }
        else
            MessageBox.Show("Setting text properties has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption);
        gdpicturePDF.CloseDocument();
    }
    else
        MessageBox.Show("The new document can't be created. Status: " + gdpicturePDF.GetStat().ToString(), caption);
}
Example
How to set attributes to a newly created tag attached to the underlined text. Dim caption As String = "Example: SetTagAttribute" Using gdpicturePDF As GdPicturePDF = New GdPicturePDF() If (gdpicturePDF.NewPDF(PdfConformance.PDF_UA_1) = GdPictureStatus.OK) AndAlso (gdpicturePDF.NewPage(PdfPageSizes.PdfPageSizeA4) = GdPictureStatus.OK) Then 'This is required to have a valid PDF_UA document. gdpicturePDF.SetTitle("My first PDF/UA document") Dim fontResName As String = gdpicturePDF.AddTrueTypeFontU("Arial", False, False, True) If (gdpicturePDF.GetStat() = GdPictureStatus.OK) AndAlso (gdpicturePDF.SetFillColor(Color.Blue) = GdPictureStatus.OK) AndAlso (gdpicturePDF.SetTextSize(20) = GdPictureStatus.OK) Then Dim tagRootID As Integer = gdpicturePDF.GetTagRootID() If (gdpicturePDF.GetStat() = GdPictureStatus.OK) AndAlso (gdpicturePDF.SetLanguage("en-US") = GdPictureStatus.OK) Then Dim tagParagraph As Integer = gdpicturePDF.NewTag(tagRootID, "P") If (gdpicturePDF.GetStat() = GdPictureStatus.OK) AndAlso (gdpicturePDF.SetTagAttribute(tagParagraph, "TextDecorationType", "Underline") = GdPictureStatus.OK) AndAlso (gdpicturePDF.SetTagAttribute(tagParagraph, "LineHeight", 20) = GdPictureStatus.OK) Then If (gdpicturePDF.BeginMarkedContentSequence(tagParagraph, "P") = GdPictureStatus.OK) AndAlso (gdpicturePDF.DrawTextUnderline(fontResName, 20, 700, "This is underlined text in english that is tagged as paragraph!", Color.Aquamarine, 3) = GdPictureStatus.OK) AndAlso (gdpicturePDF.EndMarkedContent() = GdPictureStatus.OK) Then Dim status As GdPictureStatus = gdpicturePDF.SaveToFile("test_tagged.pdf") If status = GdPictureStatus.OK Then MessageBox.Show("Your new PDF document has been successfully created.", caption) Else MessageBox.Show("The file can't be saved. Status: " + status.ToString(), caption) End If Else MessageBox.Show("Creating a tag's content has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption) End If Else MessageBox.Show("The NewTag() or SetTagAttribute() methods have failed with the status: " + gdpicturePDF.GetStat().ToString(), caption) End If Else MessageBox.Show("Getting the root or setting the language has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption) End If Else MessageBox.Show("Setting text properties has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption) End If gdpicturePDF.CloseDocument() Else MessageBox.Show("The new document can't be created. Status: " + gdpicturePDF.GetStat().ToString(), caption) End If End Using string caption = "Example: SetTagAttribute"; using (GdPicturePDF gdpicturePDF = new GdPicturePDF()) { if ((gdpicturePDF.NewPDF(PdfConformance.PDF_UA_1) == GdPictureStatus.OK) && (gdpicturePDF.NewPage(PdfPageSizes.PdfPageSizeA4) == GdPictureStatus.OK)) { //This is required to have a valid PDF_UA document. gdpicturePDF.SetTitle("My first PDF/UA document"); string fontResName = gdpicturePDF.AddTrueTypeFontU("Arial", false, false, true); if ((gdpicturePDF.GetStat() == GdPictureStatus.OK) && (gdpicturePDF.SetFillColor(Color.Blue) == GdPictureStatus.OK) && (gdpicturePDF.SetTextSize(20) == GdPictureStatus.OK)) { int tagRootID = gdpicturePDF.GetTagRootID(); if ((gdpicturePDF.GetStat() == GdPictureStatus.OK) && (gdpicturePDF.SetLanguage("en-US") == GdPictureStatus.OK)) { int tagParagraph = gdpicturePDF.NewTag(tagRootID, "P"); if ((gdpicturePDF.GetStat() == GdPictureStatus.OK) && (gdpicturePDF.SetTagAttribute(tagParagraph, "TextDecorationType", "Underline") == GdPictureStatus.OK) && (gdpicturePDF.SetTagAttribute(tagParagraph, "LineHeight", 20) == GdPictureStatus.OK)) { if ((gdpicturePDF.BeginMarkedContentSequence(tagParagraph, "P") == GdPictureStatus.OK) && (gdpicturePDF.DrawTextUnderline(fontResName, 20, 700, "This is underlined text in english that is tagged as paragraph!", Color.Aquamarine, 3) == GdPictureStatus.OK) && (gdpicturePDF.EndMarkedContent() == GdPictureStatus.OK)) { GdPictureStatus status = gdpicturePDF.SaveToFile("test_tagged.pdf"); if (status == GdPictureStatus.OK) MessageBox.Show("Your new PDF document has been successfully created.", caption); else MessageBox.Show("The file can't be saved. Status: " + status.ToString(), caption); } else MessageBox.Show("Creating a tag's content has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption); } else MessageBox.Show("The NewTag() or SetTagAttribute() methods have failed with the status: " + gdpicturePDF.GetStat().ToString(), caption); } else MessageBox.Show("Getting the root or setting the language has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption); } else MessageBox.Show("Setting text properties has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption); gdpicturePDF.CloseDocument(); } else MessageBox.Show("The new document can't be created. Status: " + gdpicturePDF.GetStat().ToString(), caption); }
See Also

Reference

GdPicturePDF Class
GdPicturePDF Members
Overload List
GetTagRootID Method
NewTag Method
BeginMarkedContent Method
BeginMarkedContentSequence Method
EndMarkedContent Method

 

 

Ⓒ Copyright 2024 Nutrient. All rights reserved