DocumentAuthor, DocumentCreator, DocumentSubject and DocumentKeywords

The DocumentAuthor, DocumentCreator, DocumentSubject and DocumentKeywords properties are used to set the metadata associated with a document.

 

Syntax

ActiveX:

System.String DocumentAuthor
System.String DocumentCreator
System.String DocumentSubject
System.String DocumentKeywords
System.String DocumentTitle

DLL:

long SetAuthor(HANDLE hIntf, LPCSTR szValue)
long SetCreator(HANDLE hIntf, LPCSTR szValue)
long SetSubject(HANDLE hIntf, LPCSTR szValue)
long SetKeywords(HANDLE hIntf, LPCSTR szValue)
long SetKeywords(HANDLE hIntf, LPCSTR szValue)
long SetTitle(HANDLE hIntf, LPCSTR szValue)

 

Parameters

DocumentAuthor, DocumentCreator, DocumentSubject, DocumentKeywords, DocumentTitle

[in, out] The various document metadata to be stored in the output DOCX, can be either Ansi or Unicode.

hIntf

HANDLE to printer returned by any of the DriverInit function calls.

szValue

[out] An ansi or Unicode string containing the attribute value.

 

Return Value

SetAuthor, SetCreator, SetSubject, SetKeywords and SetTitle return 1 if successful, 0 otherwise.

 

Remarks

These functions can be used in two situations:

  1. The developer needs to modify the default values for the printer; in this case SetDefaultConfig should be called after modifying these settings to set the value as default for all applications. Application developers should not call this function for every printout but only after printer initialization.

  2. The printer device context is created using the function CDICreateDC. This function uses the settings provided by these functions and there is no need to call SetDefaultConfig.

 

Member of CDIntfEx.CDIntfEx.

 

Example

<Flags()>


Public Enum acFileNameOptions As Integer


    ' Please check FileNameOptions for the complete flags version


    NoPrompt = &H1


    UseFileName = &H2


    Concatenate = &H4


    DisableCompression = &H8


    EmbedFonts = &H10


    BroadcastMessages = &H20


End Enum


 


 


Public Sub Sample()


    ' Constants for Activation codes


    Const strLicenseTo As String = "DOCX Converter Developer Evaluation"


    Const strActivationCode As String = "07EFCDAB010001002EE718DAABD90353AA8141F60B6762C695F4D5BA97F516CBE3EB407DC717EC1D28DE39A61F1ACE26924C99AFB190"


    Const AMYUNIPRINTERNAME As String = "Amyuni DOCX Converter"


 


    ' Declare a new cdintfex object if it does not exist in the form.


    Dim DOCX As New CDIntfEx.CDIntfEx


 


    ' Get a reference to the installed printer.


    ' This will fail if the printer name passed to the DriverInit method is 


    ' not found in the printer’s folder


    DOCX.DriverInit(AMYUNIPRINTERNAME)


 


    ' The SetDefaultPrinter function sets the system default printer to the one


    ' initialized by the DriverInit functions.


    DOCX.SetDefaultPrinter()


 


    ' Resulting DOCX document stored here


    DOCX.DefaultDirectory = "C:\Temp"


 


    ' Set Printer options


    DOCX.FileNameOptionsEx = acFileNameOptions.NoPrompt


 


    ' The EnablePrinter() method needs to be called right before each print job. 


    ' Calling the EnablePrinter() method will start a 20 second time-out value


    DOCX.EnablePrinter(strLicenseTo, strActivationCode)


 


    ' Set Document Author


    DOCX.DocumentAuthor = "Amyuni"


 


    ' Set Document Creator


    DOCX.DocumentCreator = "Amyuni Technologies"


 


    ' Set Document Subject


    DOCX.DocumentSubject = "Sample Code"


 


    ' Set Document Keywords


    DOCX.DocumentKeywords = "Amyuni, Sample, Code"


 


    ' Set Document Title


    DOCX.DocumentTitle = "Title of Sample code"


 


    ' Set the Values


    DOCX.SetDefaultConfig()


 


    ' The BatchConvert method converts a number of files to DOCX.


    DOCX.BatchConvert("C:\Temp\*.ppt")


 


    ' The RestoreDefaultPrinter function resets the system default printer 


    ' to the printer that was the default before the call to SetDefaultPrinter.


    DOCX.RestoreDefaultPrinter()


 


    ' This function will simply detach from an existing printer because the HANDLE was created using DriverInit


    DOCX.DriverEnd()


 


    ' Destroy DOCX object


    DOCX = Nothing    


End Sub


[Flags]


public enum acFileNameOptions


{


    // Please check FileNameOptions for the complete flags version


    NoPrompt = 0x00000001,


    UseFileName = 0x00000002,


    Concatenate = 0x00000004,


    DisableCompression = 0x00000008,


    EmbedFonts = 0x00000010,


    BroadcastMessages = 0x00000020,


}


 


 


public void Sample()


{


    // Constants for Activation codes


    const string strLicenseTo = "DOCX Converter Developer Evaluation";


    const string strActivationCode = "07EFCDAB010001002EE718DAABD90353AA8141F60B6762C695F4D5BA97F516CBE3EB407DC717EC1D28DE39A61F1ACE26924C99AFB190";


    const string AMYUNIPRINTERNAME = "Amyuni DOCX Converter";


 


    // Declare a new cdintfex object if it does not exist in the form.


    CDIntfEx.CDIntfEx DOCX = new CDIntfEx.CDIntfEx();


 


    // Get a reference to the installed printer.


    // This will fail if the printer name passed to the DriverInit method is 


    // not found in the printer’s folder


    DOCX.DriverInit(AMYUNIPRINTERNAME);


 


    // The SetDefaultPrinter function sets the system default printer to the one


    // initialized by the DriverInit functions.


    DOCX.SetDefaultPrinter();


 


    // Resulting DOCX document stored here


    DOCX.DefaultDirectory = @"C:\Temp";


 


    // Set Printer options


    DOCX.FileNameOptionsEx =(int)acFileNameOptions.NoPrompt;


 


    // The EnablePrinter() method needs to be called right before each print job. 


    // Calling the EnablePrinter() method will start a 20 second time-out value


    DOCX.EnablePrinter(strLicenseTo, strActivationCode);


 


    // Set Document Author


    DOCX.DocumentAuthor = "Amyuni";


 


    // Set Document Creator


    DOCX.DocumentCreator = "Amyuni Technologies";


 


    // Set Document Subject


    DOCX.DocumentSubject = "Sample Code";


 


    // Set Document Keywords


    DOCX.DocumentKeywords = "Amyuni, Sample, Code";


 


    // Set Document Title


    DOCX.DocumentTitle = "Title of Sample code";


 


    // Set the Values


    DOCX.SetDefaultConfig();


 


    // The BatchConvert method converts a number of files to DOCX.


    DOCX.BatchConvert(@"c:\\Temp\\*.ppt");


 


    // The RestoreDefaultPrinter function resets the system default printer 


    // to the printer that was the default before the call to SetDefaultPrinter.


    DOCX.RestoreDefaultPrinter();


 


    // This function will simply detach from an existing printer because the HANDLE was created using DriverInit


    DOCX.DriverEnd();


 


    // Destroy DOCX object


    DOCX = null;    


}


// DOCX Converter Cpp.cpp : Defines the entry point for the console application.


// 


 


#include <Windows.h>


#include <string>


#include <iostream>


#include "CdIntf.h"


#pragma comment(lib, "CDIntf.lib")


 


using namespace std;


 


 


int main()


{


    // Constants for Activation codes


    #define strLicenseTo  "DOCX Converter Developer Evaluation"


    #define strActivationCode "07EFCDAB010001002EE718DAABD90353AA8141F60B6762C695F4D5BA97F516CBE3EB407DC717EC1D28DE39A61F1ACE26924C99AFB190"


    #define AMYUNIPRINTERNAME "Amyuni DOCX Converter"


 


    // Get a reference to the installed printer.


    // This will fail if the printer name passed to the DriverInit method is 


    // not found in the printer’s folder


    HANDLE DOCX = DriverInit(AMYUNIPRINTERNAME);


 


    // The CDISetDefaultPrinter function sets the system default printer to the one


    // initialized by the DriverInit functions.


    CDISetDefaultPrinter(DOCX);


 


    // Resulting DOCX document stored here


    SetDefaultDirectory(DOCX, "c:\\Temp");


 


    // Set Printer options


    SetFileNameOptions(DOCX, NoPrompt);


 


    // The EnablePrinter() method needs to be called right before each print job. 


    // Calling the EnablePrinter() method will start a 20 second time-out value


    EnablePrinter(DOCX, strLicenseTo, strActivationCode);


 


    // Set Document Author


    SetAuthor(DOCX, "Amyuni");


 


    // Set Document Creator


    SetCreator(DOCX, "Amyuni Technologies");


 


    // Set Document Subject


    SetSubject(DOCX, "Sample Code");


 


    // Set Document Keywords


    SetKeywords(DOCX, "Amyuni, Sample, Code");


 


    // Set Document Title


    SetTitle(DOCX, "Title of Sample code");


 


    // Set the Values


    SetDefaultConfig(DOCX);


 


    // The BatchConvert method converts a number of files to DOCX.


    BatchConvertEx(DOCX, "c:\\Temp\\*.ppt");


 


    // The RestoreDefaultPrinter function resets the system default printer 


    // to the printer that was the default before the call to SetDefaultPrinter.


    RestoreDefaultPrinter(DOCX);


 


    // This function will simply detach from an existing printer because the HANDLE was created using DriverInit


    DriverEnd(DOCX);    


 


    // Destroy DOCX object


    DOCX = NULL;    


 


    return 0;


}


package Example;


 


import com.jacob.activeX.ActiveXComponent;


import com.jacob.com.Dispatch;


 


public class Sample {


    public enum acFileNameOptions


    {


        // Please check FileNameOptions for the complete flags version


        NoPrompt(0x00000001),


        UseFileName(0x00000002),


        Concatenate(0x00000004),


        DisableCompression(0x00000008),


        EmbedFonts(0x00000010),


        BroadcastMessages(0x00000020);


        public int value;


        public acFileNameOptions(int value)


        {


            this.value = value;


        }


        public Object value(){


            return value;


        }


    }


 


 


    public static void main(String[] args)


    {


        // Constants for Activation codes


        String strLicenseTo  = "DOCX Converter Developer Evaluation";


        String strActivationCode = "07EFCDAB010001002EE718DAABD90353AA8141F60B6762C695F4D5BA97F516CBE3EB407DC717EC1D28DE39A61F1ACE26924C99AFB190";


        String AMYUNIPRINTERNAME = "Amyuni DOCX Converter";


 


        // Declare a new cdintfex object if it does not exist in the form.


        ActiveXComponent docx = new ActiveXComponent("CDIntfEx.CDIntfEx.6.5"); 


 


        // Get a reference to the installed printer.


        // This will fail if the printer name passed to the DriverInit method is 


        // not found in the printer’s folder


        Dispatch.call(docx,"DriverInit",AMYUNIPRINTERNAME);


 


        // The SetDefaultPrinter function sets the system default printer to the one


        // initialized by the DriverInit functions.


        Dispatch.call(docx,"SetDefaultPrinter");


 


        // Resulting DOCX document stored here


        Dispatch.put(docx,"DefaultDirectory","c:\\Temp");


 


        // Set Printer options


        Dispatch.put(docx,"FileNameOptionsEx",acFileNameOptions.NoPrompt.value);


 


        // The EnablePrinter() method needs to be called right before each print job. 


        // Calling the EnablePrinter() method will start a 20 second time-out value


        Dispatch.call(docx,"EnablePrinter", strLicenseTo, strActivationCode);


 


        // Set Document Author


        Dispatch.put(docx,"DocumentAuthor", "Amyuni");


 


        // Set Document Creator


        Dispatch.put(docx,"DocumentCreator", "Amyuni Technologies");


 


        // Resulting DOCX document stored here


        Dispatch.put(docx,"DocumentAuthor", "Amyuni");


 


        // Set Document Subject


        Dispatch.put(docx,"DocumentSubject", "Sample Code");


 


        // Set Document Keywords


        Dispatch.put(docx,"DocumentKeywords", "Amyuni, Sample, Code");


 


        // Set Document Title


        Dispatch.put(docx,"DocumentTitle", "Title of Sample code");


 


        // Set the Values


        Dispatch.call(docx,"SetDefaultConfig");


 


        // The BatchConvert method converts a number of files to DOCX.


        Dispatch.call(docx,"BatchConvert","c:\\temp\\*.ppt");


 


        // The RestoreDefaultPrinter function resets the system default printer 


        // to the printer that was the default before the call to SetDefaultPrinter.


        Dispatch.call(docx,"RestoreDefaultPrinter"); 


 


        // This function will simply detach from an existing printer because the HANDLE was created using DriverInit


        Dispatch.call(docx,"DriverEnd");


 


        // Destroy DOCX object


        docx = null;        


    }


}


$acFileNameOptions = @{


    NoPrompt = 0x00000001


    UseFileName = 0x00000002


    Concatenate = 0x00000004


    DisableCompression = 0x00000008


    EmbedFonts = 0x00000010


    BroadcastMessages = 0x00000020


} 


#Please check FileNameOptions for the complete flags version


 


# Constants for Activation codes


$strLicenseTo  =  "DOCX Converter Developer Evaluation"


$strActivationCode = "07EFCDAB010001002EE718DAABD90353AA8141F60B6762C695F4D5BA97F516CBE3EB407DC717EC1D28DE39A61F1ACE26924C99AFB190"


$AMYUNIPRINTERNAME = "Amyuni DOCX Converter"


 


#Declare a new cdintfex object if it does not exist in the form.


$DOCX = New-Object -ComObject CDIntfEx.CDIntfEx.6.5


 


#Get a reference to the installed printer.


#This will fail if the printer name passed to the DriverInit method is 


#not found in the printer’s folder


[System.__ComObject].InvokeMember('DriverInit', [System.Reflection.BindingFlags]::InvokeMethod,$null,$DOCX,$AMYUNIPRINTERNAME)


 


#The SetDefaultPrinter function sets the system default printer to the one


#initialized by the DriverInit functions.


[System.__ComObject].InvokeMember('SetDefaultPrinter', [System.Reflection.BindingFlags]::InvokeMethod,$null,$DOCX,$null)


 


#Resulting DOCX document stored here


[System.__ComObject].InvokeMember('DefaultDirectory', [System.Reflection.BindingFlags]::SetProperty,$null,$DOCX,"C:\Temp")


 


#Set Printer options


[System.__ComObject].InvokeMember('FileNameOptionsEx', [System.Reflection.BindingFlags]::SetProperty,$null,$DOCX,$acFileNameOptions::NoPrompt)


 


#The EnablePrinter() method needs to be called right before each print job. 


#Calling the EnablePrinter() method will start a 20 second time-out value


[System.__ComObject].InvokeMember('EnablePrinter', [System.Reflection.BindingFlags]::InvokeMethod,$null,$DOCX, @($strLicenseTo, $strActivationCode))


 


#Set Document Author


[System.__ComObject].InvokeMember('DocumentAuthor', [System.Reflection.BindingFlags]::SetProperty,$null,$DOCX,"Amyuni")


 


#Set Document Creator


[System.__ComObject].InvokeMember('DocumentCreator', [System.Reflection.BindingFlags]::SetProperty,$null,$DOCX,"Amyuni Technologies")


 


#Set DocumentSubject


[System.__ComObject].InvokeMember('DocumentSubject', [System.Reflection.BindingFlags]::SetProperty,$null,$DOCX,"Sample Code")


 


#Set Document Keywords


[System.__ComObject].InvokeMember('DocumentKeywords', [System.Reflection.BindingFlags]::SetProperty,$null,$DOCX,"Amyuni, Sample, Code")


 


#Set Document Title


[System.__ComObject].InvokeMember('DocumentTitle', [System.Reflection.BindingFlags]::SetProperty,$null,$DOCX,"Title of Sample code")


 


#Set the Values


[System.__ComObject].InvokeMember('SetDefaultConfig', [System.Reflection.BindingFlags]::SetProperty,$null,$DOCX,$null)


 


#The BatchConvert method converts a number of files to DOCX.


[System.__ComObject].InvokeMember('BatchConvert', [System.Reflection.BindingFlags]::InvokeMethod,$null,$DOCX, "C:\temp\*.ppt")


 


#The RestoreDefaultPrinter function resets the system default printer 


#to the printer that was the default before the call to SetDefaultPrinter.


[System.__ComObject].InvokeMember('RestoreDefaultPrinter', [System.Reflection.BindingFlags]::InvokeMethod,$null,$DOCX,$null)


 


#This function will simply detach from an existing printer because the HANDLE was created using DriverInit 


[System.__ComObject].InvokeMember('DriverEnd', [System.Reflection.BindingFlags]::InvokeMethod,$null,$DOCX,$null)


 


#Destroy DOCX object


$DOCX = $null


' FileNameOptions constants


' Please check FileNameOptions for the complete flags version


Const NoPrompt = &H1


Const UseFileName = &H2


Const Concatenate = &H4


Const DisableCompression = &H8


Const EmbedFonts = &H10


Const BroadcastMessages = &H20


Const MultilingualSupport = &H80


Const EncryptDocument = &H100


Const FullEmbed = &H200


 


' Constants for Activation codes


Const strLicenseTo = "DOCX Converter Developer Evaluation"


Const strActivationCode = "07EFCDAB010001002EE718DAABD90353AA8141F60B6762C695F4D5BA97F516CBE3EB407DC717EC1D28DE39A61F1ACE26924C99AFB190"


Const AMYUNIPRINTERNAME = "Amyuni DOCX Converter"


 


' Declare a new cdintfex object


Dim DOCX


Set DOCX = CreateObject("CDIntfEx.CDIntfEx.6.5")


 


' Get a reference to the installed printer.


' This will fail if the printer name passed to the DriverInit method is


' not found in the printer’s folder


DOCX.DriverInit AMYUNIPRINTERNAME


 


' The SetDefaultPrinter function sets the system default printer to the one


' initialized by the DriverInit functions.


DOCX.SetDefaultPrinter


 


' Resulting DOCX document stored here


DOCX.DefaultDirectory = "C:\Temp"


 


' Set Printer options


DOCX.FileNameOptionsEx = NoPrompt


 


' The EnablePrinter() method needs to be called right before each print job.


' Calling the EnablePrinter() method will start a 20 second time-out value


DOCX.EnablePrinter strLicenseTo, strActivationCode


 


' Set Document Author


DOCX.DocumentAuthor = "Amyuni"


 


' Set Document Creator


DOCX.DocumentCreator = "Amyuni Technologies"


 


' Set Document Subject


DOCX.DocumentSubject = "Sample Code"


 


' Set Document Keywords


DOCX.DocumentKeywords = "Amyuni, Sample, Code"


 


' Set Document Title


DOCX.DocumentTitle = "Title of Sample code"


 


' Set the Values


DOCX.SetDefaultConfig


 


' The BatchConvert method converts a number of files to DOCX.


DOCX.BatchConvert "C:\Temp\*.ppt"


 


' The RestoreDefaultPrinter function resets the system default printer


' to the printer that was the default before the call to SetDefaultPrinter.


DOCX.RestoreDefaultPrinter


 


' This function will simply detach from an existing printer because the HANDLE was created using DriverInit


DOCX.DriverEnd


 


' Destroy DOCX object


Set DOCX = Nothing