DeleteOCG(Int32) Method

In This Topic

Deletes an optional content group (OCG) entry, specified by its unique identifier, from the currently loaded PDF document. This method only removes the specified OCG entry in the OCG entries dictionary, which subsequently makes the content of that layer visible within the document.

Syntax

Visual Basic
C#
Delphi
JScript
Managed Extensions for C++
C++/CLI

'Declaration
 
Public Overloads Function DeleteOCG( _
   ByVal OCGId As Integer _
) As GdPictureStatus

public GdPictureStatus DeleteOCG( 
   int OCGId
)

public function DeleteOCG( 
    OCGId: Integer
): GdPictureStatus;

public function DeleteOCG( 
   OCGId : int
) : GdPictureStatus;

public: GdPictureStatus DeleteOCG( 
   int OCGId
)

public:
GdPictureStatus DeleteOCG( 
   int OCGId
)

Parameters

OCGId: The unique identifier of the required OCG entry that you want to delete. You can obtain this identifier using the GdPicturePDF.GetOCG method.

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 this method only deletes the specified OCG entry in the OCGs dictionary, which means, that the content itself of the specified layer is not removed and stay visible within the document.

Example

How to delete the specified OCG entry in the PDF document.

VB.NET
C#

Dim caption As String = "Example: DeleteOCG"
Dim gdpicturePDF As New GdPicturePDF()
'Please see the example of the SetImageOptional() method for the test_ImageLayer.pdf file.
If gdpicturePDF.LoadFromFile("test_ImageLayer.pdf", False) = GdPictureStatus.OK Then
    Dim ocgCount As Integer = gdpicturePDF.GetOCGCount()
    If (gdpicturePDF.GetStat() = GdPictureStatus.OK) AndAlso (ocgCount > 0) Then
        Dim ocgID As Integer = gdpicturePDF.GetOCG(0)
        If gdpicturePDF.GetStat() = GdPictureStatus.OK Then
            If gdpicturePDF.DeleteOCG(ocgID) = GdPictureStatus.OK Then
                If gdpicturePDF.SaveToFile("test_DeletedLayer.pdf") = GdPictureStatus.OK Then
                    MessageBox.Show("The example HAS been followed successfully and the file has been saved.", caption)
                Else
                    MessageBox.Show("The example HAS been followed successfully, but the file can't be saved. Status: " + gdpicturePDF.GetStat().ToString(), caption)
                End If
            Else
                MessageBox.Show("The DeleteOCG() method has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption)
            End If
        Else
            MessageBox.Show("The GetOCG() method has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption)
        End If
    Else
        MessageBox.Show("The GetOCGCount() method has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption)
    End If
Else
    MessageBox.Show("The file can't be loaded.", caption)
End If
gdpicturePDF.Dispose()

string caption = "Example: DeleteOCG";
GdPicturePDF gdpicturePDF = new GdPicturePDF();
//Please see the example of the SetImageOptional() method for the test_ImageLayer.pdf file.
if (gdpicturePDF.LoadFromFile("test_ImageLayer.pdf", false) == GdPictureStatus.OK)
{
    int ocgCount = gdpicturePDF.GetOCGCount();
    if ((gdpicturePDF.GetStat() == GdPictureStatus.OK) && (ocgCount > 0))
    {
        int ocgID = gdpicturePDF.GetOCG(0);
        if (gdpicturePDF.GetStat() == GdPictureStatus.OK)
        {
            if (gdpicturePDF.DeleteOCG(ocgID) == GdPictureStatus.OK)
            {
                if (gdpicturePDF.SaveToFile("test_DeletedLayer.pdf") == GdPictureStatus.OK)
                {
                    MessageBox.Show("The example HAS been followed successfully and the file has been saved.", caption);
                }
                else
                {
                    MessageBox.Show("The example HAS been followed successfully, but the file can't be saved. Status: " + gdpicturePDF.GetStat().ToString(), caption);
                }
            }
            else
            {
                MessageBox.Show("The DeleteOCG() method has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption);
            }
        }
        else
        {
            MessageBox.Show("The GetOCG() method has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption);
        }
    }
    else
    {
        MessageBox.Show("The GetOCGCount() method has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption);
    }
}
else
{
    MessageBox.Show("The file can't be loaded.", caption);
}
gdpicturePDF.Dispose();

Reference

GdPicturePDF Class
GdPicturePDF Members
Overload List
NewOCG Method
GetOCGCount Method
GetOCG Method
SetImageOptional Method
SetFormFieldOptional Method
BeginOCGMarkedContent Method
EndOCGMarkedContent Method