You are here: COM Interface > Structs, Records, Enums > dtengine::FieldFlags Enumeration
dtSearch Text Retrieval Engine Programmer's Reference
dtengine::FieldFlags Enumeration

File: dten600.idl 

Library: dtengine 

Module: COM Interface 

enum FieldFlags { dtsoFfSkipFilenameField = 0x0001, dtsoFfSkipDocumentProperties = 0x0002, dtsoFfHtmlShowLinks = 0x0004, dtsoFfHtmlShowImgSrc = 0x0008, dtsoFfHtmlShowComments = 0x0010, dtsoFfHtmlShowScripts = 0x0020, dtsoFfHtmlShowStylesheets = 0x0040, dtsoFfHtmlShowMetatags = 0x0080, 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 };
dtsoFfSkipFilenameField = 0x0001
Do not generate a field named Filename containing the name of the file.
dtsoFfSkipDocumentProperties = 0x0002
Do not index or search document summary fields
dtsoFfHtmlShowLinks = 0x0004
Make HTML links searchable
dtsoFfHtmlShowImgSrc = 0x0008
Make HTML IMG src= attribute searchable
dtsoFfHtmlShowComments = 0x0010
Make HTML Comments searchable
dtsoFfHtmlShowScripts = 0x0020
Make HTML Scripts searchable
dtsoFfHtmlShowStylesheets = 0x0040
Make HTML style sheets searchable
dtsoFfHtmlShowMetatags = 0x0080
Make HTML meta tags searchable and visible, appended to the body of the HTML file
dtsoFfHtmlShowHiddenContent = 0x01fc
all of the dtsoFfHtmlShow* flags
dtsoFfHtmlNoHeaderFields = 0x0200
Suppress generation of HtmlTitle, HtmlH1, etc. fields
dtsoFfOfficeSkipHiddenContent = 0x0400
Skip non-text streams in Office documents
dtsoFfXmlHideFieldNames = 0x0800
In XML, make field names not searchable
dtsoFfShowNtfsProperties = 0x1000
Make NTFS file properties searchable
dtsoFfXmlSkipAttributes = 0x2000
Do not index attributes in XML files
dtsoFfSkipFilenameFieldPath = 0x4000
Include only the filename (not the path) in the Filename field generated at the end of each document.
dtsoFfPdfSkipAttachments = 0x8000
Skip attachments in PDF files
dtsoFfHtmlSkipInputValues = 0x10000
Skip HTML INPUT tag "value" attributes
dtsoFfHtmlSkipImageAlt = 0x20000
Skip HTML IMG tag "alt" attributes,
dtsoFfIncludeFileTypeField = 0x40000
Add file type field indicating the file format of the document (ex: "Microsoft Word")
dtsoFfIncludeFileTypeIdField = 0x80000
Add numeric type id field with the type id indicating the file format of the document
dtsoFfSkipDataSourceFields = 0x100000
Suppress fields passed through the DataSource API through DataSource.DocFields or FileConverter.InputFields.
dtsoFfSkipEmailHeaders = 0x200000
Suppress display of headers in emails.

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.

Copyright (c) 1995-2022 dtSearch Corp. All rights reserved.