You are here: Symbol Reference
> dtSearch.Engine Namespace
> FieldFlags Enumeration
Close
dtSearch .NET Standard API 2021.02
dtSearch.Engine.FieldFlags Enumeration

Control indexing of meta-data associated with documents

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
dtsoFfHtmlShowNoframesContent
Make content inside NOFRAMES 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 (Obsolete -- see dtsoFfHtmlIndexHeadersAsFields) These fields are now disabled by default. Set dtsoFfHtmlIndexHeadersAsFields to enable them.
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
dtsoFfIncludeDocumentPropertiesCaption
Include a caption "Document Properties" on the table of document properties in Word, Excel, and PowerPoint 2003 documents
dtsoFfShowImageProperties
Display properties of image files embedded in documents
dtsoFfSkipEmailProperties
Suppress display of email properties (subject, sender, recipient, etc.)
dtsoFfPdfShowLinks
Make links in PDF files searchable
dtsoFfGenerateMd5Hash
Generate an MD5 hash for each document indexed and append it as a field named MD5Hash. Generation of MD5 hashes is time-consuming so this will make indexing slower.
dtsoFfGenerateSha256Hash
Generate an Sha256 hash for each document indexed and append it as a field named Sha256Hash. Generation of hashes is time-consuming so this will make indexing slower.
dtsoFfHtmlIndexHeadersAsFields
Automatically generate HtmlH1, HtmlH2, etc. fields for content inside H1, H2, etc. tags, and an HtmlTitle field for content inside HTML Title tags. This replaces dtsoFfHtmlNoHeaderFields. Beginning with version 7.88, these rarely-used fields are disabled by default, so dtsoFfHtmlIndexHeadersAsFields must be set to enable them.
dtsoFfNormalizeEmailAddresses
Normalize email addresses in email header fields, removing extra spacing and quotation marks and moving comments to the end of the name or address portion.

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

Copyright (c) 1998-2021 dtSearch Corp. All rights reserved.