SchemaValues Property

Summary

Gets the schema item values for this embedded file.

Syntax

C++/CLI

Java

Python

public IDictionary<string, string> SchemaValues {get;}

public java.util.Map<java.lang.String, 
    java.lang.String> getSchemaValues();

public:  
   property IDictionary<String^, String^>^ SchemaValues 
   { 
      IDictionary<String^, String^>^ get() 
   }

SchemaValues # get  (PDFEmbeddedFile)

Property Value

The schema item values for this embedded file.

Remarks

If the owner is a PDF portfolio, then the PDFDocument.EmbeddedFilesSchemas collection is populated with the schemas to be used with embedded files.

Each PDFEmbeddedFile will then contain the values for these schemas in the SchemaValues dictionary and the following conditions are true:

The number of items in the dictionary equals the number of items in PDFDocument.EmbeddedFilesSchemas.
The SchemaValues dictionary contains an item with the key equal to one of the PDFSchema.Key values in PDFDocument.EmbeddedFilesSchemas.

Using this information, an application program can find the schema for any embedded file and use it to build the UI to view the PDF document as intended.

Refer to PDFDocument.EmbeddedFiles for more information on using PDFSchema with PDF portfolio and embedded files.

Example

Java

using Leadtools; 
using Leadtools.Codecs; 
using Leadtools.Controls; 
using Leadtools.Pdf; 
using Leadtools.Svg; 
using Leadtools.WinForms; 
 
 
public static void ExtractEmbeddedFiles(string inputFileName, string outputDir) 
{ 
   // Load the source document 
   PDFDocument pdfDocument = new PDFDocument(inputFileName); 
   if (!pdfDocument.HasEmbeddedFiles) 
   { 
      Console.WriteLine("PDF does not have embedded files"); 
      // No embedded files 
      pdfDocument.Dispose(); 
      return; 
   } 
 
   // Read the attachments 
   pdfDocument.ParseDocumentStructure(PDFParseDocumentStructureOptions.EmbeddedFiles); 
 
   if (!Directory.Exists(outputDir)) 
      Directory.CreateDirectory(outputDir); 
 
   foreach (PDFEmbeddedFile embeddedFile in pdfDocument.EmbeddedFiles) 
   { 
      // Show this file information 
      Console.WriteLine($"Number:{embeddedFile.FileNumber}"); 
      Console.WriteLine($"  FileName:{embeddedFile.FileName}"); 
      Console.WriteLine($"  FileSize:{embeddedFile.FileSize}"); 
      Console.WriteLine($"  Description:{embeddedFile.Description}"); 
      Console.WriteLine($"  Created:{embeddedFile.Created}"); 
      Console.WriteLine($"  Modified:{embeddedFile.Modified}"); 
 
      // Extract this attachment to the output directory 
      // Note: FileName of an embedded file is not guaranteed to be unique, therefore, we will append 
      // the file number which is unique to the output name 
      string outputFileName = $"{embeddedFile.FileNumber}-{embeddedFile.FileName}"; 
      Console.WriteLine($"  Extracting to {outputFileName}"); 
      outputFileName = Path.Combine(outputDir, outputFileName); 
      PDFFile.ExtractEmbeddedFile(inputFileName, pdfDocument.Password, embeddedFile.FileNumber, outputFileName); 
   } 
 
   pdfDocument.Dispose(); 
}

 
import java.io.BufferedWriter; 
import java.io.Console; 
import java.io.File; 
import java.io.FileWriter; 
import java.io.IOException; 
import java.io.OutputStream; 
import java.io.OutputStreamWriter; 
import java.nio.Buffer; 
import java.nio.file.Files; 
import java.nio.file.Path; 
import java.nio.file.Paths; 
import java.nio.file.StandardOpenOption; 
import java.sql.Date; 
import java.text.SimpleDateFormat; 
import java.time.LocalDateTime; 
import java.util.ArrayList; 
import java.util.List; 
 
import javax.xml.validation.Schema; 
 
import org.apache.lucene.store.Directory; 
import org.junit.*; 
import org.junit.runner.JUnitCore; 
import org.junit.runner.Result; 
import org.junit.runner.notification.Failure; 
import static org.junit.Assert.*; 
 
import leadtools.*; 
import leadtools.barcode.*; 
import leadtools.codecs.*; 
import leadtools.pdf.*; 
import leadtools.svg.*; 
 
 
public void pdfDocumentExtractEmbeddedFilesExample() { 
   String inputFileName = "C:\\LEADTOOLS23\\Resources\\Images\\Leadtools.pdf"; 
   String outputDir = "C:\\LEADTOOLS23\\Bin"; 
   // Load the source document 
   PDFDocument pdfDocument = new PDFDocument(inputFileName); 
   if (!pdfDocument.hasEmbeddedFiles()) { 
      System.out.println("PDF does not have embedded files"); 
      // No embedded files 
      pdfDocument.dispose(); 
      return; 
   } 
 
   // Read the attachments 
   pdfDocument.parseDocumentStructure(PDFParseDocumentStructureOptions.EMBEDDED_FILES.getValue()); 
 
   File directory = new File(String.valueOf(outputDir)); 
   if (!directory.exists()) 
      directory.mkdir(); 
 
   for (PDFEmbeddedFile embeddedFile : pdfDocument.getEmbeddedFiles()) { 
      // Show this file information 
      System.out.println("Number:" + embeddedFile.getFileNumber()); 
      System.out.println("FileName:" + embeddedFile.getFileName()); 
      System.out.println("FileSize:" + embeddedFile.getFileSize()); 
      System.out.println("Description:" + embeddedFile.getDescription()); 
      System.out.println("Created:" + embeddedFile.getCreated()); 
      System.out.println("Modified:" + embeddedFile.getModified()); 
 
      // Extract this attachment to the output directory 
      // Note: FileName of an embedded file is not guaranteed to be unique, therefore, 
      // we will append 
      // the file number which is unique to the output name 
      String outputFileName = embeddedFile.getFileNumber() + "-" + embeddedFile.getFileName(); 
      System.out.println(" Extracting to " + outputFileName); 
      outputFileName = combine(outputDir, outputFileName); 
      PDFFile.extractEmbeddedFile(inputFileName, pdfDocument.getPassword(), embeddedFile.getFileNumber(), 
            outputFileName); 
   } 
 
   pdfDocument.dispose(); 
}

Requirements

Target Platforms

Reference

PDFEmbeddedFile Class

PDFEmbeddedFile Members

Leadtools.Pdf Namespace

Download our FREE evaluation

Help Version 23.0.2024.2.29

Leadtools.Pdf Assembly

Introduction

Getting Started

Namespaces

Leadtools.Pdf Namespace

Assemblies