I'm still testing the Eval version of PDF Converter.
I have found these undocumented methods - can you please provide documentation, including explanations of the parameters?
For example, AutoBookmarks - What is "Level" and what are the params?
Thanks.
Here's my list:
FOR DOCUMENT:
AutoBookMarks
AutoHyperlinks
SearchText
SearchTextEx
SetFlateCompression
SetHyperlinkInternal
SetHyperlinkURL
Split
SplitXY
FOR CDIntfEx:
DevModeFlags
EMFDriverInit
GLock
GUnLock
KeepPreProcessed
SetDocEmailProps
SetDocEmailPropsEx
SetDocServerProps
StartSpooler
StopSpooler
TestLock
Several questions about non-documented methods
Hello,
I have tried to provide below a breif discription of some of the methods missign in our documetnaion.
AutoBookMarks
AutoBookmarks(levels As Long, fonts As String, StartPage As Long)
fonts = String in the form of: FontName,FontSize,Weight,Italic,Underline
This function will automatically generate a bookmark tree based on the bookmark levels and the Font family provided.
Example:
AutoBookmarks(2, “Arial,20,400,0,0;Courier,12,400,0,â€, 1)
The code snippet above will create a parent bookmark when it encounters a first font and it will create a child or level 2 when it finds the send font.
AutoHyperlinks
AutoHyperlinks(prefixes As String)
This function will look in the PDF document and based the prefixes provided will create a hyperlink.
example:
AutoHyperlinks(“http://;wwwâ€)
This code snippet above will create hyperlinks when ever the prefixes are found in the document.
SearchText/ SearchTextEx
SearchText(Start As Integer, Text As String, Page As Long, xPos As Double, yPos As Double) As Boolean
Searches a PDF document for a specific text and returns the page where the text is found and the coordinates of the text within that page. This method returns True if the text was found, False otherwise.
'Parameters:
'Start : 0 to continue searching from the last location, -1 to restart
'Text : text to search for
'Page : on return, page number where text was found
'xPos : on return, horizontal position of text
'yPos : on return, vertical position of text
SetFlateCompression
Sub SetFlateCompression(Ratio As Integer)
Set the FlateCompression of a document
SetHyperlinkInternal
''Function SetHyperLinkInternal(PageNumber As Long, xStart As Long, yStart As Long, xEnd As Long, yEnd As Long, DestPageNumber As Long, xDest As Long, yDest As Long) As Boolean
Example:
The code snippet below will set hyperlink to top of page 2. The hyperlink is located at the 0,0 xy coordinate of page 1
PDFdoc.SetHyperLinkInternal 1, 0, 0, 500, 500, 2, 0, 0
SetHyperlinkURL
'SetHyperLinkURL(PageNumber As Long, xStart As Long, yStart As Long, xEnd As Long, yEnd As Long, URL As String)
Example:
Set hyperlink at a xy coordinate that points to a URL
PDFdoc.SetHyperLinkURL 1, 0, 0, 500, 500, "www.amyuni.com"
Split
The PDF Converter's Split function enables the developer to split one PDF file into multiple PDF files, one for each page or group of pages.
SplitXY
The PDF Converter's SplitXY function enables the developer to split documents based on text and XY coordinates on the document. The SplitXY() function will read the text located at the specified location and generate a file each time the text changes.
FOR CDIntfEx:
DevModeFlags
EMFDriverInit
The EMFDriverInit function can be used to create a new printer when the application is launched and remove it when the application is closed. This functions is an aliases the same xxxDriverInit internal function. It has been kept in version 2.5 for compatibility with previous versions.
GLock
GUnLock
The Glock and Gunlock are globally locking funtions. These functions are used when the Document name is not known.
KeepPreProcessed
This is an internal function
SetDocEmailProps
Function SetDocEmailProps(szDocTitle As String, szTo As String, szCC As String, szBCC As String, szSubject As String, szMessage As String, lPrompt As Long) As Long
Please look at the Lock/Unlock features of the PDF Converter for information how to implement this function
SetDocEmailPropsEx
Function SetDocEmailPropsEx(szDocTitle As String, szSmtpServer As String, lSmtpPort As Long, szFrom As String, szTo As String, szCC As String, szBCC As String, szSubject As String, szMessage As String, lFlags As Long) As Long
Please look at the Lock/Unlock features of the PDF Converter for information how to implement this function
SetDocServerProps
Function SetDocServerProps(szDocTitle As String, szHostname As String, szUsername As String) As Long
Please look at the Lock/Unlock features of the PDF Converter for information how to implement this function
TestLock
This is an internal function
Hope this helps?
Jose
I have tried to provide below a breif discription of some of the methods missign in our documetnaion.
AutoBookMarks
AutoBookmarks(levels As Long, fonts As String, StartPage As Long)
fonts = String in the form of: FontName,FontSize,Weight,Italic,Underline
This function will automatically generate a bookmark tree based on the bookmark levels and the Font family provided.
Example:
AutoBookmarks(2, “Arial,20,400,0,0;Courier,12,400,0,â€, 1)
The code snippet above will create a parent bookmark when it encounters a first font and it will create a child or level 2 when it finds the send font.
AutoHyperlinks
AutoHyperlinks(prefixes As String)
This function will look in the PDF document and based the prefixes provided will create a hyperlink.
example:
AutoHyperlinks(“http://;wwwâ€)
This code snippet above will create hyperlinks when ever the prefixes are found in the document.
SearchText/ SearchTextEx
SearchText(Start As Integer, Text As String, Page As Long, xPos As Double, yPos As Double) As Boolean
Searches a PDF document for a specific text and returns the page where the text is found and the coordinates of the text within that page. This method returns True if the text was found, False otherwise.
'Parameters:
'Start : 0 to continue searching from the last location, -1 to restart
'Text : text to search for
'Page : on return, page number where text was found
'xPos : on return, horizontal position of text
'yPos : on return, vertical position of text
SetFlateCompression
Sub SetFlateCompression(Ratio As Integer)
Set the FlateCompression of a document
SetHyperlinkInternal
''Function SetHyperLinkInternal(PageNumber As Long, xStart As Long, yStart As Long, xEnd As Long, yEnd As Long, DestPageNumber As Long, xDest As Long, yDest As Long) As Boolean
Example:
The code snippet below will set hyperlink to top of page 2. The hyperlink is located at the 0,0 xy coordinate of page 1
PDFdoc.SetHyperLinkInternal 1, 0, 0, 500, 500, 2, 0, 0
SetHyperlinkURL
'SetHyperLinkURL(PageNumber As Long, xStart As Long, yStart As Long, xEnd As Long, yEnd As Long, URL As String)
Example:
Set hyperlink at a xy coordinate that points to a URL
PDFdoc.SetHyperLinkURL 1, 0, 0, 500, 500, "www.amyuni.com"
Split
The PDF Converter's Split function enables the developer to split one PDF file into multiple PDF files, one for each page or group of pages.
SplitXY
The PDF Converter's SplitXY function enables the developer to split documents based on text and XY coordinates on the document. The SplitXY() function will read the text located at the specified location and generate a file each time the text changes.
FOR CDIntfEx:
DevModeFlags
EMFDriverInit
The EMFDriverInit function can be used to create a new printer when the application is launched and remove it when the application is closed. This functions is an aliases the same xxxDriverInit internal function. It has been kept in version 2.5 for compatibility with previous versions.
GLock
GUnLock
The Glock and Gunlock are globally locking funtions. These functions are used when the Document name is not known.
KeepPreProcessed
This is an internal function
SetDocEmailProps
Function SetDocEmailProps(szDocTitle As String, szTo As String, szCC As String, szBCC As String, szSubject As String, szMessage As String, lPrompt As Long) As Long
Please look at the Lock/Unlock features of the PDF Converter for information how to implement this function
SetDocEmailPropsEx
Function SetDocEmailPropsEx(szDocTitle As String, szSmtpServer As String, lSmtpPort As Long, szFrom As String, szTo As String, szCC As String, szBCC As String, szSubject As String, szMessage As String, lFlags As Long) As Long
Please look at the Lock/Unlock features of the PDF Converter for information how to implement this function
SetDocServerProps
Function SetDocServerProps(szDocTitle As String, szHostname As String, szUsername As String) As Long
Please look at the Lock/Unlock features of the PDF Converter for information how to implement this function
TestLock
This is an internal function
Hope this helps?
Jose
Hello,
I have tried to provide below a breif discription of some of the methods missign in our documetnaion.
AutoBookMarks
AutoBookmarks(levels As Long, fonts As String, StartPage As Long)
fonts = String in the form of: FontName,FontSize,Weight,Italic,Underline
This function will automatically generate a bookmark tree based on the bookmark levels and the Font family provided.
Example:
AutoBookmarks(2, “Arial,20,400,0,0;Courier,12,400,0,â€, 1)
The code snippet above will create a parent bookmark when it encounters a first font and it will create a child or level 2 when it finds the send font.
AutoHyperlinks
AutoHyperlinks(prefixes As String)
This function will look in the PDF document and based the prefixes provided will create a hyperlink.
example:
AutoHyperlinks(“http://;wwwâ€)
This code snippet above will create hyperlinks when ever the prefixes are found in the document.
SearchText/ SearchTextEx
SearchText(Start As Integer, Text As String, Page As Long, xPos As Double, yPos As Double) As Boolean
Searches a PDF document for a specific text and returns the page where the text is found and the coordinates of the text within that page. This method returns True if the text was found, False otherwise.
'Parameters:
'Start : 0 to continue searching from the last location, -1 to restart
'Text : text to search for
'Page : on return, page number where text was found
'xPos : on return, horizontal position of text
'yPos : on return, vertical position of text
SetFlateCompression
Sub SetFlateCompression(Ratio As Integer)
Set the FlateCompression of a document
SetHyperlinkInternal
''Function SetHyperLinkInternal(PageNumber As Long, xStart As Long, yStart As Long, xEnd As Long, yEnd As Long, DestPageNumber As Long, xDest As Long, yDest As Long) As Boolean
Example:
The code snippet below will set hyperlink to top of page 2. The hyperlink is located at the 0,0 xy coordinate of page 1
PDFdoc.SetHyperLinkInternal 1, 0, 0, 500, 500, 2, 0, 0
SetHyperlinkURL
'SetHyperLinkURL(PageNumber As Long, xStart As Long, yStart As Long, xEnd As Long, yEnd As Long, URL As String)
Example:
Set hyperlink at a xy coordinate that points to a URL
PDFdoc.SetHyperLinkURL 1, 0, 0, 500, 500, "www.amyuni.com"
Split
The PDF Converter's Split function enables the developer to split one PDF file into multiple PDF files, one for each page or group of pages.
SplitXY
The PDF Converter's SplitXY function enables the developer to split documents based on text and XY coordinates on the document. The SplitXY() function will read the text located at the specified location and generate a file each time the text changes.
FOR CDIntfEx:
DevModeFlags
EMFDriverInit
The EMFDriverInit function can be used to create a new printer when the application is launched and remove it when the application is closed. This functions is an aliases the same xxxDriverInit internal function. It has been kept in version 2.5 for compatibility with previous versions.
GLock
GUnLock
The Glock and Gunlock are globally locking funtions. These functions are used when the Document name is not known.
KeepPreProcessed
This is an internal function
SetDocEmailProps
Function SetDocEmailProps(szDocTitle As String, szTo As String, szCC As String, szBCC As String, szSubject As String, szMessage As String, lPrompt As Long) As Long
Please look at the Lock/Unlock features of the PDF Converter for information how to implement this function
SetDocEmailPropsEx
Function SetDocEmailPropsEx(szDocTitle As String, szSmtpServer As String, lSmtpPort As Long, szFrom As String, szTo As String, szCC As String, szBCC As String, szSubject As String, szMessage As String, lFlags As Long) As Long
Please look at the Lock/Unlock features of the PDF Converter for information how to implement this function
SetDocServerProps
Function SetDocServerProps(szDocTitle As String, szHostname As String, szUsername As String) As Long
Please look at the Lock/Unlock features of the PDF Converter for information how to implement this function
TestLock
This is an internal function
Hope this helps?
Jose
I have tried to provide below a breif discription of some of the methods missign in our documetnaion.
AutoBookMarks
AutoBookmarks(levels As Long, fonts As String, StartPage As Long)
fonts = String in the form of: FontName,FontSize,Weight,Italic,Underline
This function will automatically generate a bookmark tree based on the bookmark levels and the Font family provided.
Example:
AutoBookmarks(2, “Arial,20,400,0,0;Courier,12,400,0,â€, 1)
The code snippet above will create a parent bookmark when it encounters a first font and it will create a child or level 2 when it finds the send font.
AutoHyperlinks
AutoHyperlinks(prefixes As String)
This function will look in the PDF document and based the prefixes provided will create a hyperlink.
example:
AutoHyperlinks(“http://;wwwâ€)
This code snippet above will create hyperlinks when ever the prefixes are found in the document.
SearchText/ SearchTextEx
SearchText(Start As Integer, Text As String, Page As Long, xPos As Double, yPos As Double) As Boolean
Searches a PDF document for a specific text and returns the page where the text is found and the coordinates of the text within that page. This method returns True if the text was found, False otherwise.
'Parameters:
'Start : 0 to continue searching from the last location, -1 to restart
'Text : text to search for
'Page : on return, page number where text was found
'xPos : on return, horizontal position of text
'yPos : on return, vertical position of text
SetFlateCompression
Sub SetFlateCompression(Ratio As Integer)
Set the FlateCompression of a document
SetHyperlinkInternal
''Function SetHyperLinkInternal(PageNumber As Long, xStart As Long, yStart As Long, xEnd As Long, yEnd As Long, DestPageNumber As Long, xDest As Long, yDest As Long) As Boolean
Example:
The code snippet below will set hyperlink to top of page 2. The hyperlink is located at the 0,0 xy coordinate of page 1
PDFdoc.SetHyperLinkInternal 1, 0, 0, 500, 500, 2, 0, 0
SetHyperlinkURL
'SetHyperLinkURL(PageNumber As Long, xStart As Long, yStart As Long, xEnd As Long, yEnd As Long, URL As String)
Example:
Set hyperlink at a xy coordinate that points to a URL
PDFdoc.SetHyperLinkURL 1, 0, 0, 500, 500, "www.amyuni.com"
Split
The PDF Converter's Split function enables the developer to split one PDF file into multiple PDF files, one for each page or group of pages.
SplitXY
The PDF Converter's SplitXY function enables the developer to split documents based on text and XY coordinates on the document. The SplitXY() function will read the text located at the specified location and generate a file each time the text changes.
FOR CDIntfEx:
DevModeFlags
EMFDriverInit
The EMFDriverInit function can be used to create a new printer when the application is launched and remove it when the application is closed. This functions is an aliases the same xxxDriverInit internal function. It has been kept in version 2.5 for compatibility with previous versions.
GLock
GUnLock
The Glock and Gunlock are globally locking funtions. These functions are used when the Document name is not known.
KeepPreProcessed
This is an internal function
SetDocEmailProps
Function SetDocEmailProps(szDocTitle As String, szTo As String, szCC As String, szBCC As String, szSubject As String, szMessage As String, lPrompt As Long) As Long
Please look at the Lock/Unlock features of the PDF Converter for information how to implement this function
SetDocEmailPropsEx
Function SetDocEmailPropsEx(szDocTitle As String, szSmtpServer As String, lSmtpPort As Long, szFrom As String, szTo As String, szCC As String, szBCC As String, szSubject As String, szMessage As String, lFlags As Long) As Long
Please look at the Lock/Unlock features of the PDF Converter for information how to implement this function
SetDocServerProps
Function SetDocServerProps(szDocTitle As String, szHostname As String, szUsername As String) As Long
Please look at the Lock/Unlock features of the PDF Converter for information how to implement this function
TestLock
This is an internal function
Hope this helps?
Jose
Sorry - I have several more questions - about bookmarks -
Can you explain a bit more about how a bookmark is determined?
From your description below, it seems like each time a specific font is encountered, a bookmark is created?
What if the document only uses one font?
What if there is a table, and several fonts are used within one 'row'?
What if you are not the Author of the original document - how can you know what fonts are used, and how many levels to expect?
Sorry, but I am very confused about this... can you please help clear this up?
Example:
AutoBookmarks(2, “Arial,20,400,0,0;Courier,12,400,0,â€, 1)
The code snippet above will create a parent bookmark when it encounters a first font and it will create a child or level 2 when it finds the send font.
Can you explain a bit more about how a bookmark is determined?
From your description below, it seems like each time a specific font is encountered, a bookmark is created?
What if the document only uses one font?
What if there is a table, and several fonts are used within one 'row'?
What if you are not the Author of the original document - how can you know what fonts are used, and how many levels to expect?
Sorry, but I am very confused about this... can you please help clear this up?
Example:
AutoBookmarks(2, “Arial,20,400,0,0;Courier,12,400,0,â€, 1)
The code snippet above will create a parent bookmark when it encounters a first font and it will create a child or level 2 when it finds the send font.
Hello,
You're right my last comments do not really make since.
AutoBookMarks
AutoBookmarks(levels As Long, fonts As String, StartPage As Long)
fonts = String in the form of: FontName,FontSize,Weight,Italic,Underline
This function will automatically generate a bookmark tree based on the bookmark levels and the Font family provided.
Example:
AutoBookmarks(2, “Arial,20,400,0,0;Courier,12,400,0,â€, 1)
The code snippet above will create a parent bookmark when it encounters the first font defined in the AutoBookmarks function. In the example above it will look for the “Arial†font with a 20pt size, regular weight and not italics or underline.
When the function finds the “Courier,12,400,0†font, it will create a child or level 2 bookmark .
The fonts definitions are separated by a “;â€.
This function is typically used when trying to add bookmarks to a PDF document which contain (example: Chapter headingss in a particular font). The function will add a bookmark that point to these font locations in the document.
Hope this helps?
Jose
You're right my last comments do not really make since.
AutoBookMarks
AutoBookmarks(levels As Long, fonts As String, StartPage As Long)
fonts = String in the form of: FontName,FontSize,Weight,Italic,Underline
This function will automatically generate a bookmark tree based on the bookmark levels and the Font family provided.
Example:
AutoBookmarks(2, “Arial,20,400,0,0;Courier,12,400,0,â€, 1)
The code snippet above will create a parent bookmark when it encounters the first font defined in the AutoBookmarks function. In the example above it will look for the “Arial†font with a 20pt size, regular weight and not italics or underline.
When the function finds the “Courier,12,400,0†font, it will create a child or level 2 bookmark .
The fonts definitions are separated by a “;â€.
This function is typically used when trying to add bookmarks to a PDF document which contain (example: Chapter headingss in a particular font). The function will add a bookmark that point to these font locations in the document.
Hope this helps?
Jose