PdfDocumentMetadataGetCustomField Method |
Attempts to retrieve the value of a custom field from the
PdfDocumentMetadata object.
Namespace:
Atalasoft.PdfDoc
Assembly:
Atalasoft.PdfDoc (in Atalasoft.PdfDoc.dll) Version: 11.4.0.9.0.377 (.NET 4.5.2, x86)
Syntax public string GetCustomField(
string name
)
Public Function GetCustomField (
name As String
) As String
Parameters
- name
- Type: SystemString
The name of a custom field in the metadata. See
AddCustomField(String, String)
for restrictions.
Return Value
Type:
String
A string containing the metadata.
Remarks
The PDF specification requires that all custom field values be strings. It
is possible, however, that some PDF files will contain illegal, non-string
metadata. GetCustomField attempts to represent the data as a string. If it
fails, it will throw an IllegalCastException. If client code is attempting
to read specific, non-string data, it is best to get the data directly from
the
CustomFields
property.
See Also