Click or drag to resize
IQMSGetDocumentBookmarkNames Method
Retrieves a list of all document book marks defined in the document.

Namespace: PIX.Services.V12
Assembly: 
Syntax
List<string> GetDocumentBookmarkNames(
	QDSDocumentSession session
)

Parameters

session
Type: PIX.QMSAPI.DataObjectsQDSDocumentSession
The session to be used.

Return Value

Type: ListString
A list of bookmark names.
Remarks
Security note Security Note

Requires membership of local group QlikView Management API and the role Document Folder Administrator.

Examples
This example retrieves a list of all document bookmarks in a document and prints them to the console.

The service key injection is assumed to be handled behind the scenes. For an example of how to inject the service key, see Samples.

C#
using System;
using System.Collections.Generic;
using System.Linq;
using QMSAPI;

class Program
{
    static void Main(string[] args)
    {
        try
        {
            // create a QMS API client
            IQMS apiClient = new QMSClient();

            //retrieve a time limited service key
            ServiceKeyClientMessageInspector.ServiceKey = apiClient.GetTimeLimitedServiceKey();

            ServiceInfo serviceInfo = apiClient.GetServices(ServiceTypes.QlikViewDistributionService).FirstOrDefault();
            if (serviceInfo != null)
            {
                QDSDocumentSessionConfiguration sessionConfig = new QDSDocumentSessionConfiguration();

                sessionConfig.QDSID = serviceInfo.ID;
                sessionConfig.FilePath = @"C:\ProgramData\QlikTech\SourceDocuments\Test.qvw";

                QDSDocumentSession documentSession = apiClient.CreateSession(sessionConfig);

                if (documentSession != null && documentSession.OpenDocumentResult == DocumentState.OpenedSuccessfully)
                {
                    List<string> bookmarkNames = apiClient.GetDocumentBookmarkNames(documentSession);
                    bookmarkNames.ForEach(Console.WriteLine);

                    apiClient.CloseSession(documentSession);
                }
                else
                {
                    Console.WriteLine("Failed to open the document.");
                }
            }
        }
        catch (Exception ex)
        {
            Console.WriteLine("An exception occurred: " + ex.Message);
        }
        // wait for user to press any key
        Console.ReadLine();
    }
}
See Also