A unique tag identifier of the tag's tree element.
A new value of the language identifier for a specified tag's tree element as a string.

Please refer to the PDF Reference, Section "Language Identifiers" for the proper syntax of language codes.

Example





In This Topic
GdPicture14 Namespace / GdPicturePDF Class / SetTagLanguage Method

SetTagLanguage Method (GdPicturePDF)

In This Topic
Sets the natural language for all text in the 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. You can override the document's natural language by setting this property for the single structure element if needed.

For further assistance, please refer to the PDF Reference, Section "Language Specification Hierarchy".

Syntax
'Declaration

 


Public Function SetTagLanguage( _

   ByVal TagID As Integer, _

   ByVal Language As String _

) As GdPictureStatus
public GdPictureStatus SetTagLanguage( 

   int TagID,

   string Language

)
public function SetTagLanguage( 

    TagID: Integer;

    Language: String

): GdPictureStatus; 
public function SetTagLanguage( 

   TagID : int,

   Language : String

) : GdPictureStatus;
public: GdPictureStatus SetTagLanguage( 

   int TagID,

   string* Language

) 
public:

GdPictureStatus SetTagLanguage( 

   int TagID,

   String^ Language

)

Parameters

TagID
A unique tag identifier of the tag's tree element.
Language
A new value of the language identifier for a specified tag's tree element as a string.

Please refer to the PDF Reference, Section "Language Identifiers" for the proper syntax of language codes.

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.

Be aware that you need to respect the proper syntax described in the PDF Reference, Section "Language Identifiers" to specify the required language.

Example
How to set up a natural language to be used with a newly created tag element. 
Dim caption As String = "Example: SetTagLanguage"

Using gdpicturePDF As GdPicturePDF = New GdPicturePDF()

    If (gdpicturePDF.NewPDF(PdfConformance.PDF_UA_1) = GdPictureStatus.OK) AndAlso

       (gdpicturePDF.NewPage(PdfPageSizes.PdfPageSizeA4) = GdPictureStatus.OK) Then

        gdpicturePDF.SetOrigin(PdfOrigin.PdfOriginTopLeft)

        '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(16) = GdPictureStatus.OK) Then

            Dim tagRootID As Integer = gdpicturePDF.GetTagRootID()

            If gdpicturePDF.GetStat() = GdPictureStatus.OK Then

                'Setting the natural language for the whole document.

                gdpicturePDF.SetLanguage("en-US")

                Dim tagParagraph As Integer = gdpicturePDF.NewTag(tagRootID, "P")

                If gdpicturePDF.GetStat() = GdPictureStatus.OK Then

                    'Setting the language for the drawn text in the paragraph tag.

                    If (gdpicturePDF.SetTagLanguage(tagParagraph, "es-MX") = GdPictureStatus.OK) AndAlso

                       (gdpicturePDF.SetTagActualText(tagParagraph, "Hasta la vista.") = GdPictureStatus.OK) AndAlso

                       (gdpicturePDF.BeginMarkedContentSequence(tagParagraph, "P") = GdPictureStatus.OK) AndAlso

                       (gdpicturePDF.DrawText(fontResName, 50, 50, "Hasta la vista.") = 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("Tagging of the paragraph has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption)

                    End If

                Else

                    MessageBox.Show("The NewTag() method has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption)

                End If

            Else

                MessageBox.Show("The GetTagRootID() method 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: SetTagLanguage";

using (GdPicturePDF gdpicturePDF = new GdPicturePDF())

{

    if ((gdpicturePDF.NewPDF(PdfConformance.PDF_UA_1) == GdPictureStatus.OK) &&

        (gdpicturePDF.NewPage(PdfPageSizes.PdfPageSizeA4) == GdPictureStatus.OK))

    {

        gdpicturePDF.SetOrigin(PdfOrigin.PdfOriginTopLeft);

        //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(16) == GdPictureStatus.OK))

        {

            int tagRootID = gdpicturePDF.GetTagRootID();

            if (gdpicturePDF.GetStat() == GdPictureStatus.OK)

            {

                //Setting the natural language for the whole document.

                gdpicturePDF.SetLanguage("en-US");

                int tagParagraph = gdpicturePDF.NewTag(tagRootID, "P");

                if (gdpicturePDF.GetStat() == GdPictureStatus.OK)

                {

                    //Setting the language for the drawn text in the paragraph tag.

                    if ((gdpicturePDF.SetTagLanguage(tagParagraph, "es-MX") == GdPictureStatus.OK) &&

                        (gdpicturePDF.SetTagActualText(tagParagraph, "Hasta la vista.") == GdPictureStatus.OK) &&

                        (gdpicturePDF.BeginMarkedContentSequence(tagParagraph, "P") == GdPictureStatus.OK) &&

                        (gdpicturePDF.DrawText(fontResName, 50, 50, "Hasta la vista.") == 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("Tagging of the paragraph has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption);

                }

                else

                    MessageBox.Show("The NewTag() method has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption);

            }

            else

                MessageBox.Show("The GetTagRootID() method 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 up a natural language to be used with a newly created tag element. Dim caption As String = "Example: SetTagLanguage" Using gdpicturePDF As GdPicturePDF = New GdPicturePDF() If (gdpicturePDF.NewPDF(PdfConformance.PDF_UA_1) = GdPictureStatus.OK) AndAlso (gdpicturePDF.NewPage(PdfPageSizes.PdfPageSizeA4) = GdPictureStatus.OK) Then gdpicturePDF.SetOrigin(PdfOrigin.PdfOriginTopLeft) '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(16) = GdPictureStatus.OK) Then Dim tagRootID As Integer = gdpicturePDF.GetTagRootID() If gdpicturePDF.GetStat() = GdPictureStatus.OK Then 'Setting the natural language for the whole document. gdpicturePDF.SetLanguage("en-US") Dim tagParagraph As Integer = gdpicturePDF.NewTag(tagRootID, "P") If gdpicturePDF.GetStat() = GdPictureStatus.OK Then 'Setting the language for the drawn text in the paragraph tag. If (gdpicturePDF.SetTagLanguage(tagParagraph, "es-MX") = GdPictureStatus.OK) AndAlso (gdpicturePDF.SetTagActualText(tagParagraph, "Hasta la vista.") = GdPictureStatus.OK) AndAlso (gdpicturePDF.BeginMarkedContentSequence(tagParagraph, "P") = GdPictureStatus.OK) AndAlso (gdpicturePDF.DrawText(fontResName, 50, 50, "Hasta la vista.") = 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("Tagging of the paragraph has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption) End If Else MessageBox.Show("The NewTag() method has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption) End If Else MessageBox.Show("The GetTagRootID() method 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: SetTagLanguage"; using (GdPicturePDF gdpicturePDF = new GdPicturePDF()) { if ((gdpicturePDF.NewPDF(PdfConformance.PDF_UA_1) == GdPictureStatus.OK) && (gdpicturePDF.NewPage(PdfPageSizes.PdfPageSizeA4) == GdPictureStatus.OK)) { gdpicturePDF.SetOrigin(PdfOrigin.PdfOriginTopLeft); //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(16) == GdPictureStatus.OK)) { int tagRootID = gdpicturePDF.GetTagRootID(); if (gdpicturePDF.GetStat() == GdPictureStatus.OK) { //Setting the natural language for the whole document. gdpicturePDF.SetLanguage("en-US"); int tagParagraph = gdpicturePDF.NewTag(tagRootID, "P"); if (gdpicturePDF.GetStat() == GdPictureStatus.OK) { //Setting the language for the drawn text in the paragraph tag. if ((gdpicturePDF.SetTagLanguage(tagParagraph, "es-MX") == GdPictureStatus.OK) && (gdpicturePDF.SetTagActualText(tagParagraph, "Hasta la vista.") == GdPictureStatus.OK) && (gdpicturePDF.BeginMarkedContentSequence(tagParagraph, "P") == GdPictureStatus.OK) && (gdpicturePDF.DrawText(fontResName, 50, 50, "Hasta la vista.") == 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("Tagging of the paragraph has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption); } else MessageBox.Show("The NewTag() method has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption); } else MessageBox.Show("The GetTagRootID() method 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
GetTagRootID Method
NewTag Method
SetTagTitle Method
SetTagAlternateDescription Method
SetTagActualText Method
SetLanguage Method