GetFieldList Method
Overloads
GetFieldList(QDSDocumentSession) |
Retrieves all available fields from a document. |
GetFieldList(QDSDocumentSession)
Retrieves all available fields from a document.
Declaration
List<Field> GetFieldList(QDSDocumentSession session)
Parameters
Type | Name | Description |
---|---|---|
QDSDocumentSession | session |
The document session to be used. |
Returns
Type | Description |
---|---|
System.Collections.Generic.List<Field> |
A list of fields |
Remarks
security
Requires membership of local group QlikView Management API and the role Document Folder Administrator.
Examples
This example retrieves all fields from 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.
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\Sales.qvw";
QDSDocumentSession documentSession = apiClient.CreateSession(sessionConfig);
if (documentSession != null && documentSession.OpenDocumentResult == DocumentState.OpenedSuccessfully)
{
List<Field> fields = apiClient.GetFieldList(documentSession);
fields.ForEach(f=>Console.WriteLine(f.Name));
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();
}
}
Did this page help you?
If you find any issues with this page or its content – a typo, a missing step, or a technical error – let us know how we can improve!