FieldFlags Class

Control indexing of meta-data associated with documents

public class FieldFlags;

File

FieldFlags.java

Remarks

FieldFlags provide options to control the indexing of meta-data associated with documents. When highlighting hits, it is important to make sure that FieldFlags has the same options that were used when a document was indexed. Otherwise, hit highlighting may be incorrect due to differences in the words found in each document.

By default, dtSearch will index fields in documents such as the Summary Information fields in Word files and META tags in HTML files. FieldFlags can be used to suppress some or all of this metadata.

dtSearch will also add a "Filename" field to the end of each document, with the full path and filename of the document, so words in the document name will be searchable like other text. To suppress this completely, use dtsoFfSkipFilenameField. To include only the name of the document (not the path), use dtsoSkipFilenameFieldPath.

The dtsoFfHtmlShow* flags can be used to make normally hidden HTML elements, such as styles or links, visible and searchable. For each category of element that is enabled, a section will be added to the end of the HTML file listing the items in that category. For example, if dtsoFfHtmlShowComments is set, then each HTML file will have a list of the embedded comments after the body of the HTML.

API

C++: dtsOptions.fieldFlags

Java: Options.setFieldFlags()

.NET: Options.FieldFlags

COM: Options.FieldFlags

Fields

Field	Description
dtsoFfHtmlNoHeaderFields	Suppress generation of HtmlTitle, HtmlH1, etc.
dtsoFfHtmlShowComments	Make HTML Comments searchable
dtsoFfHtmlShowHiddenContent	All of the dtsoFfHtmlShow* flags
dtsoFfHtmlShowImgSrc	Make HTML IMG src= attribute searchable
dtsoFfHtmlShowLinks	Make HTML links searchable
dtsoFfHtmlShowMetatags	Make HTML meta tags searchable and visible, appended to the body of the HTML file
dtsoFfHtmlShowNoframesContent
dtsoFfHtmlShowScripts	Make HTML Scripts searchable
dtsoFfHtmlShowStylesheets	Make HTML style sheets searchable
dtsoFfHtmlSkipImageAlt	Skip HTML IMG tag "alt" attributes,
dtsoFfHtmlSkipInputValues	Skip HTML INPUT tag "value" attributes
dtsoFfIncludeFileTypeField	Add file type field indicating the file format of the document (ex: "Microsoft Word")
dtsoFfIncludeFileTypeIdField	Add numeric type id field with the type id indicating the file format of the document
dtsoFfIndexArchiveFileLists	Index the names of files in ZIP and RAR archives
dtsoFfOfficeSkipHiddenContent	Skip non-text streams in Office documents
dtsoFfPdfSkipAttachments	Skip attachments in PDF files. If a PDF file has attachments, those attachments can be in any file format, so Adobe Reader cannot be used to highlight hits because it can only highlight hits in PDF data. Therefore, a PDF file with attachments must be hit-highlighted through file conversion like other document formats. Skipping PDF attachments enables PDF files with attachments to be hit-highlighted using Adobe Reader.
dtsoFfShowNtfsProperties	Make NTFS file properties searchable
dtsoFfSkipDataSourceFields	Suppress fields passed through the DataSource API through DataSource.DocFields or FileConverter.InputFields.
dtsoFfSkipDocumentProperties	Do not index or search document summary fields
dtsoFfSkipEmailHeaders	Suppress display of headers in emails.
dtsoFfSkipFilenameField	Do not generate a field named Filename containing the name of the file.
dtsoFfSkipFilenameFieldPath	Include only the filename (not the path) in the Filename field generated at the end of each document.
dtsoFfXmlHideFieldNames	In XML, make field names not searchable
dtsoFfXmlSkipAttributes	Do not index attributes in XML files

Data Member

Fields, Constants, Legend, Members