GdPicture.NET.14.API
GdPicture14 Namespace / GdPicturePDF Class / GetOCGViewState Method
The unique identifier of the required OCG entry. You can obtain this identifier using the GdPicturePDF.GetOCG method.
Example





In This Topic
GetOCGViewState Method (GdPicturePDF)
In This Topic
Returns the value of the View state setting of an optional content group specified by its unique identifier.

The View state indicates the onscreen visibility, that means if the content of this group is viewable.

Syntax
'Declaration
 

Public Function GetOCGViewState( _
   ByVal OCGId As Integer _
) As PdfOcgState
public PdfOcgState GetOCGViewState( 
   int OCGId
)
public function GetOCGViewState( 
    OCGId: Integer
): PdfOcgState; 
public function GetOCGViewState( 
   OCGId : int
) : PdfOcgState;
public: PdfOcgState GetOCGViewState( 
   int OCGId
) 
public:
PdfOcgState GetOCGViewState( 
   int OCGId
)

Parameters

OCGId
The unique identifier of the required OCG entry. You can obtain this identifier using the GdPicturePDF.GetOCG method.

Return Value

A member of the PdfOcgState enumeration. The value of the View state setting. The GdPicturePDF.GetStat method can be subsequently used to determine if this method has been successful.
Remarks
This method is only allowed for use with non-encrypted documents.

It is recommend to use the GdPicturePDF.GetStat method to identify the specific reason for the method's failure, if any.

Example
How to find out the View state of the specified layer and some other layer's properties. 
Dim gdpicturePDF As New GdPicturePDF()
Dim status As GdPictureStatus = gdpicturePDF.LoadFromFile("test.pdf", False)
If status = GdPictureStatus.OK Then
    Dim output As String = ""
    Dim ocgCount As Integer = gdpicturePDF.GetOCGCount()
    status = gdpicturePDF.GetStat()
    If status = GdPictureStatus.OK Then
        output = "The number of OCG layers: " + ocgCount.ToString()
        Dim OcgId As Integer = 0
        Dim title As String = ""
        Dim state As PdfOcgState = PdfOcgState.Undefined
        Dim onOff As Boolean = False
        For i As Integer = 0 To ocgCount - 1
            output = output + vbCrLf + "Nr." + (i + 1).ToString() + ": "
            OcgId = gdpicturePDF.GetOCG(i)
            status = gdpicturePDF.GetStat()
            If status = GdPictureStatus.OK Then
                title = gdpicturePDF.GetOCGTitle(OcgId)
                status = gdpicturePDF.GetStat()
                If status = GdPictureStatus.OK Then
                    output = output + "Title = " + title.ToString()
                Else
                    output = output + "Title = Error (" + status.ToString() + ")"
                End If
            
                state = gdpicturePDF.GetOCGViewState(OcgId)
                status = gdpicturePDF.GetStat()
                If status = GdPictureStatus.OK Then
                    output = output + " ; View = " + state.ToString()
                Else
                    output = output + " ; View = Error (" + status.ToString() + ")"
                End If
            
                state = gdpicturePDF.GetOCGExportState(OcgId)
                status = gdpicturePDF.GetStat()
                If status = GdPictureStatus.OK Then
                    output = output + " ; Export = " + state.ToString()
                Else
                    output = output + " ; Export = Error (" + status.ToString() + ")"
                End If
            
                state = gdpicturePDF.GetOCGPrintState(OcgId)
                status = gdpicturePDF.GetStat()
                If status = GdPictureStatus.OK Then
                    output = output + " ; Print = " + state.ToString()
                Else
                    output = output + " ; Print = Error (" + status.ToString() + ")"
                End If
            
                onOff = gdpicturePDF.GetOCGLockedState(OcgId)
                status = gdpicturePDF.GetStat()
                If status = GdPictureStatus.OK Then
                    output = output + " ; Locked = " + onOff.ToString()
                Else
                    output = output + " ; Locked = Error (" + status.ToString() + ")"
                End If
            Else
                output = output + "The GetOCG() method has failed with the status: " + status.ToString()
            End If
        Next
        MessageBox.Show(output, "Example: GetOCGViewState")
    Else
        MessageBox.Show("The GetOCGCount() method has failed with the status: " + status.ToString(), "Example: GetOCGViewState")
    End If
Else
    MessageBox.Show("The file can't be loaded.", "Example: GetOCGViewState")
End If
gdpicturePDF.Dispose()
GdPicturePDF gdpicturePDF = new GdPicturePDF();
GdPictureStatus status = gdpicturePDF.LoadFromFile("test.pdf", false);
if (status == GdPictureStatus.OK)
{
    string output = "";
    int ocgCount = gdpicturePDF.GetOCGCount();
    status = gdpicturePDF.GetStat();
    if (status == GdPictureStatus.OK)
    {
        output = "The number of OCG layers: " + ocgCount.ToString();
        int OcgId = 0;
        string title = "";
        PdfOcgState state = PdfOcgState.Undefined;
        bool onOff = false;
        for (int i = 0; i < ocgCount; i++)
        {
            output = output + "\nNr." + (i + 1).ToString() + ": ";
            OcgId = gdpicturePDF.GetOCG(i);
            status = gdpicturePDF.GetStat();
            if (status == GdPictureStatus.OK)
            {
                title = gdpicturePDF.GetOCGTitle(OcgId);
                status = gdpicturePDF.GetStat();
                if (status == GdPictureStatus.OK)
                    output = output + "Title = " + title.ToString();
                else
                    output = output + "Title = Error (" + status.ToString() + ")";
            
                state = gdpicturePDF.GetOCGViewState(OcgId);
                status = gdpicturePDF.GetStat();
                if (status == GdPictureStatus.OK)
                    output = output + " ; View = " + state.ToString();
                else
                    output = output + " ; View = Error (" + status.ToString() + ")";
            
                state = gdpicturePDF.GetOCGExportState(OcgId);
                status = gdpicturePDF.GetStat();
                if (status == GdPictureStatus.OK)
                    output = output + " ; Export = " + state.ToString();
                else
                    output = output + " ; Export = Error (" + status.ToString() + ")";
            
                state = gdpicturePDF.GetOCGPrintState(OcgId);
                status = gdpicturePDF.GetStat();
                if (status == GdPictureStatus.OK)
                    output = output + " ; Print = " + state.ToString();
                else
                    output = output + " ; Print = Error (" + status.ToString() + ")";
            
                onOff = gdpicturePDF.GetOCGLockedState(OcgId);
                status = gdpicturePDF.GetStat();
                if (status == GdPictureStatus.OK)
                    output = output + " ; Locked = " + onOff.ToString();
                else
                    output = output + " ; Locked = Error (" + status.ToString() + ")";
            }
            else
                output = output + "The GetOCG() method has failed with the status: " + status.ToString();
        }
        MessageBox.Show(output, "Example: GetOCGViewState");
    }
    else
    {
        MessageBox.Show("The GetOCGCount() method has failed with the status: " + status.ToString(), "Example: GetOCGViewState");
    }
}
else
{
    MessageBox.Show("The file can't be loaded.", "Example: GetOCGViewState");
}
gdpicturePDF.Dispose();
Example
How to find out the View state of the specified layer and some other layer's properties. Dim gdpicturePDF As New GdPicturePDF() Dim status As GdPictureStatus = gdpicturePDF.LoadFromFile("test.pdf", False) If status = GdPictureStatus.OK Then Dim output As String = "" Dim ocgCount As Integer = gdpicturePDF.GetOCGCount() status = gdpicturePDF.GetStat() If status = GdPictureStatus.OK Then output = "The number of OCG layers: " + ocgCount.ToString() Dim OcgId As Integer = 0 Dim title As String = "" Dim state As PdfOcgState = PdfOcgState.Undefined Dim onOff As Boolean = False For i As Integer = 0 To ocgCount - 1 output = output + vbCrLf + "Nr." + (i + 1).ToString() + ": " OcgId = gdpicturePDF.GetOCG(i) status = gdpicturePDF.GetStat() If status = GdPictureStatus.OK Then title = gdpicturePDF.GetOCGTitle(OcgId) status = gdpicturePDF.GetStat() If status = GdPictureStatus.OK Then output = output + "Title = " + title.ToString() Else output = output + "Title = Error (" + status.ToString() + ")" End If state = gdpicturePDF.GetOCGViewState(OcgId) status = gdpicturePDF.GetStat() If status = GdPictureStatus.OK Then output = output + " ; View = " + state.ToString() Else output = output + " ; View = Error (" + status.ToString() + ")" End If state = gdpicturePDF.GetOCGExportState(OcgId) status = gdpicturePDF.GetStat() If status = GdPictureStatus.OK Then output = output + " ; Export = " + state.ToString() Else output = output + " ; Export = Error (" + status.ToString() + ")" End If state = gdpicturePDF.GetOCGPrintState(OcgId) status = gdpicturePDF.GetStat() If status = GdPictureStatus.OK Then output = output + " ; Print = " + state.ToString() Else output = output + " ; Print = Error (" + status.ToString() + ")" End If onOff = gdpicturePDF.GetOCGLockedState(OcgId) status = gdpicturePDF.GetStat() If status = GdPictureStatus.OK Then output = output + " ; Locked = " + onOff.ToString() Else output = output + " ; Locked = Error (" + status.ToString() + ")" End If Else output = output + "The GetOCG() method has failed with the status: " + status.ToString() End If Next MessageBox.Show(output, "Example: GetOCGViewState") Else MessageBox.Show("The GetOCGCount() method has failed with the status: " + status.ToString(), "Example: GetOCGViewState") End If Else MessageBox.Show("The file can't be loaded.", "Example: GetOCGViewState") End If gdpicturePDF.Dispose() GdPicturePDF gdpicturePDF = new GdPicturePDF(); GdPictureStatus status = gdpicturePDF.LoadFromFile("test.pdf", false); if (status == GdPictureStatus.OK) { string output = ""; int ocgCount = gdpicturePDF.GetOCGCount(); status = gdpicturePDF.GetStat(); if (status == GdPictureStatus.OK) { output = "The number of OCG layers: " + ocgCount.ToString(); int OcgId = 0; string title = ""; PdfOcgState state = PdfOcgState.Undefined; bool onOff = false; for (int i = 0; i < ocgCount; i++) { output = output + "\nNr." + (i + 1).ToString() + ": "; OcgId = gdpicturePDF.GetOCG(i); status = gdpicturePDF.GetStat(); if (status == GdPictureStatus.OK) { title = gdpicturePDF.GetOCGTitle(OcgId); status = gdpicturePDF.GetStat(); if (status == GdPictureStatus.OK) output = output + "Title = " + title.ToString(); else output = output + "Title = Error (" + status.ToString() + ")"; state = gdpicturePDF.GetOCGViewState(OcgId); status = gdpicturePDF.GetStat(); if (status == GdPictureStatus.OK) output = output + " ; View = " + state.ToString(); else output = output + " ; View = Error (" + status.ToString() + ")"; state = gdpicturePDF.GetOCGExportState(OcgId); status = gdpicturePDF.GetStat(); if (status == GdPictureStatus.OK) output = output + " ; Export = " + state.ToString(); else output = output + " ; Export = Error (" + status.ToString() + ")"; state = gdpicturePDF.GetOCGPrintState(OcgId); status = gdpicturePDF.GetStat(); if (status == GdPictureStatus.OK) output = output + " ; Print = " + state.ToString(); else output = output + " ; Print = Error (" + status.ToString() + ")"; onOff = gdpicturePDF.GetOCGLockedState(OcgId); status = gdpicturePDF.GetStat(); if (status == GdPictureStatus.OK) output = output + " ; Locked = " + onOff.ToString(); else output = output + " ; Locked = Error (" + status.ToString() + ")"; } else output = output + "The GetOCG() method has failed with the status: " + status.ToString(); } MessageBox.Show(output, "Example: GetOCGViewState"); } else { MessageBox.Show("The GetOCGCount() method has failed with the status: " + status.ToString(), "Example: GetOCGViewState"); } } else { MessageBox.Show("The file can't be loaded.", "Example: GetOCGViewState"); } gdpicturePDF.Dispose();
See Also

Reference

GdPicturePDF Class
GdPicturePDF Members
GetOCG Method
GetStat Method
GetStat Method
GetOCGCount Method
GetOCG Method
GetOCGTitle Method
GetOCGExportState Method
GetOCGIntentView Method
GetOCGLockedState Method
GetOCGPrintState Method
NewOCG Method

 

 

Ⓒ Copyright 2024 Nutrient. All rights reserved