SetBookmarkTextAttribute Method (GdPicturePDF)
Sets the style characteristics of the text to be used for displaying the bookmark's title of a bookmark item specified by its unique identifier.
The supported characteristics are: plain (normal text), italic, bold, bold&italic.
public function SetBookmarkTextAttribute(
: Integer;
: Integer
): GdPictureStatus;
public function SetBookmarkTextAttribute(
: int,
: int
) : GdPictureStatus;
'Declaration
Public Function SetBookmarkTextAttribute( _
ByVal As Integer, _
ByVal As Integer _
) As GdPictureStatus
Parameters
- BookmarkID
- A unique bookmark identifier specifying a required bookmark object.
You can obtain this identifier using these methods: GdPicturePDF.NewBookmark, GdPicturePDF.GetBookmarkRootID, GdPicturePDF.GetBookmarkFirstChildID, GdPicturePDF.GetBookmarkNextID, GdPicturePDF.GetBookmarkPrevID or GdPicturePDF.GetBookmarkParentID.
- Attribute
- The style characteristics of the bookmark's text of the specified bookmark item as an integer value.
The values are defined as follows: 1 for Italic text, 2 for Bold text, 3 for Bold&Italic text, 0 means no value is specified (normal text).
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.
How to set the style characteristics of the text to bold (to be used for displaying the bookmark's title) to all bookmark items on the first level of the
bookmark's hierarchy in the PDF document.
Dim caption As String = "Example: SetBookmarkTextAttribute"
Dim gdpicturePDF As New GdPicturePDF()
Dim status As GdPictureStatus = gdpicturePDF.LoadFromFile("bookmarks.pdf", False)
If status = GdPictureStatus.OK Then
Dim bookmarkID As Integer = gdpicturePDF.GetBookmarkRootID()
status = gdpicturePDF.GetStat()
If status = GdPictureStatus.OK Then
While status = GdPictureStatus.OK
status = gdpicturePDF.SetBookmarkColor(bookmarkID, 2)
If status = GdPictureStatus.OK Then
bookmarkID = gdpicturePDF.GetBookmarkNextID(bookmarkID)
status = gdpicturePDF.GetStat()
End If
End While
If status = GdPictureStatus.PropertyNotFound Then
status = gdpicturePDF.SaveToFile("bookmarks_SetTextAttribute.pdf")
If status = GdPictureStatus.OK Then
MessageBox.Show("The example HAS been followed successfully.", caption)
Else
MessageBox.Show("The file can't be saved. Status: " + status.ToString(), caption)
End If
Else
MessageBox.Show("The example HAS NOT been followed successfully." + vbCrLf + "The error status is: " + status, caption)
End If
Else
If status = GdPictureStatus.PropertyNotFound Then
MessageBox.Show("This PDF document doesn't contain any bookmarks.", caption)
Else
MessageBox.Show("The GetBookmarkRootID() method has failed with the status: " + status.ToString(), caption)
End If
End If
Else
MessageBox.Show("The file can't be loaded. Status: " + status.ToString(), caption)
End If
gdpicturePDF.Dispose()
string caption = "Example: SetBookmarkTextAttribute";
GdPicturePDF gdpicturePDF = new GdPicturePDF();
GdPictureStatus status = gdpicturePDF.LoadFromFile("bookmarks.pdf", false);
if (status == GdPictureStatus.OK)
{
int bookmarkID = gdpicturePDF.GetBookmarkRootID();
status = gdpicturePDF.GetStat();
if (status == GdPictureStatus.OK)
{
while (status == GdPictureStatus.OK)
{
status = gdpicturePDF.SetBookmarkTextAttribute(bookmarkID, 2);
if (status == GdPictureStatus.OK)
{
bookmarkID = gdpicturePDF.GetBookmarkNextID(bookmarkID);
status = gdpicturePDF.GetStat();
}
}
if (status == GdPictureStatus.PropertyNotFound)
{
status = gdpicturePDF.SaveToFile("bookmarks_SetTextAttribute.pdf");
if (status == GdPictureStatus.OK)
MessageBox.Show("The example HAS been followed successfully.", caption);
else
MessageBox.Show("The file can't be saved. Status: " + status.ToString(), caption);
}
else
MessageBox.Show("The example HAS NOT been followed successfully.\nThe error status is: " + status, caption);
}
else
{
if (status == GdPictureStatus.PropertyNotFound)
MessageBox.Show("This PDF document doesn't contain any bookmarks.", caption);
else
MessageBox.Show("The GetBookmarkRootID() method has failed with the status: " + status.ToString(), caption);
}
}
else
{
MessageBox.Show("The file can't be loaded. Status: " + status.ToString(), caption);
}
gdpicturePDF.Dispose();