dtSearch::Engine::FieldFlags Enumeration

Control indexing of meta-data associated with documents

[System::Flags]
public enum FieldFlags {
  dtsoFfSkipFilenameField = 0x0001,
  dtsoFfSkipDocumentProperties = 0x0002,
  dtsoFfHtmlShowLinks = 0x0004,
  dtsoFfHtmlShowImgSrc = 0x0008,
  dtsoFfHtmlShowComments = 0x0010,
  dtsoFfHtmlShowScripts = 0x0020,
  dtsoFfHtmlShowStylesheets = 0x0040,
  dtsoFfHtmlShowMetatags = 0x0080,
  dtsoFfHtmlShowNoframesContent = 0x0100,
  dtsoFfHtmlShowHiddenContent = 0x01fc,
  dtsoFfHtmlNoHeaderFields = 0x0200,
  dtsoFfOfficeSkipHiddenContent = 0x0400,
  dtsoFfXmlHideFieldNames = 0x0800,
  dtsoFfShowNtfsProperties = 0x1000,
  dtsoFfXmlSkipAttributes = 0x2000,
  dtsoFfSkipFilenameFieldPath = 0x4000,
  dtsoFfPdfSkipAttachments = 0x8000,
  dtsoFfHtmlSkipInputValues = 0x10000,
  dtsoFfHtmlSkipImageAlt = 0x20000,
  dtsoFfIncludeFileTypeField = 0x40000,
  dtsoFfIncludeFileTypeIdField = 0x80000,
  dtsoFfSkipDataSourceFields = 0x100000,
  dtsoFfSkipEmailHeaders = 0x200000,
  dtsoFfIndexArchiveFileLists = 0x400000
}

Visual Basic

<System::Flags>
Public Enum FieldFlags
  dtsoFfSkipFilenameField = &H0001
  dtsoFfSkipDocumentProperties = &H0002
  dtsoFfHtmlShowLinks = &H0004
  dtsoFfHtmlShowImgSrc = &H0008
  dtsoFfHtmlShowComments = &H0010
  dtsoFfHtmlShowScripts = &H0020
  dtsoFfHtmlShowStylesheets = &H0040
  dtsoFfHtmlShowMetatags = &H0080
  dtsoFfHtmlShowNoframesContent = &H0100
  dtsoFfHtmlShowHiddenContent = &H01fc
  dtsoFfHtmlNoHeaderFields = &H0200
  dtsoFfOfficeSkipHiddenContent = &H0400
  dtsoFfXmlHideFieldNames = &H0800
  dtsoFfShowNtfsProperties = &H1000
  dtsoFfXmlSkipAttributes = &H2000
  dtsoFfSkipFilenameFieldPath = &H4000
  dtsoFfPdfSkipAttachments = &H8000
  dtsoFfHtmlSkipInputValues = &H10000
  dtsoFfHtmlSkipImageAlt = &H20000
  dtsoFfIncludeFileTypeField = &H40000
  dtsoFfIncludeFileTypeIdField = &H80000
  dtsoFfSkipDataSourceFields = &H100000
  dtsoFfSkipEmailHeaders = &H200000
  dtsoFfIndexArchiveFileLists = &H400000
End Enum

Members

Members	Description
dtsoFfSkipFilenameField	Do not generate a field named Filename containing the name of the file.
dtsoFfSkipDocumentProperties	Do not index or search document summary fields
dtsoFfHtmlShowLinks	Make HTML links searchable
dtsoFfHtmlShowImgSrc	Make HTML IMG src= attribute searchable
dtsoFfHtmlShowComments	Make HTML Comments searchable
dtsoFfHtmlShowScripts	Make HTML Scripts searchable
dtsoFfHtmlShowStylesheets	Make HTML style sheets searchable
dtsoFfHtmlShowMetatags	Make HTML meta tags searchable and visible, appended to the body of the HTML file
dtsoFfHtmlShowHiddenContent	All of the dtsoFfHtmlShow* flags
dtsoFfHtmlNoHeaderFields	Suppress generation of HtmlTitle, HtmlH1, etc. fields
dtsoFfOfficeSkipHiddenContent	Skip non-text streams in Office documents
dtsoFfXmlHideFieldNames	In XML, make field names not searchable
dtsoFfShowNtfsProperties	Make NTFS file properties searchable
dtsoFfXmlSkipAttributes	Do not index attributes in XML files
dtsoFfSkipFilenameFieldPath	Include only the filename (not the path) in the Filename field generated at the end of each document.
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.
dtsoFfHtmlSkipInputValues	Skip HTML INPUT tag "value" attributes
dtsoFfHtmlSkipImageAlt	Skip HTML IMG tag "alt" 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
dtsoFfSkipDataSourceFields	Suppress fields passed through the DataSource API through DataSource.DocFields or FileConverter.InputFields.
dtsoFfSkipEmailHeaders	Suppress display of headers in emails.
dtsoFfIndexArchiveFileLists	Index the names of files in ZIP and RAR archives

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