| AbstractFilePreTweaker Class |
Namespace: Sdl.FileTypeSupport.Framework.Core.Utilities.NativeApi
The AbstractFilePreTweaker type exposes the following members.
| Name | Description | |
|---|---|---|
| AbstractFilePreTweaker |
AbstractFilePreTweaker constructor
|
| Name | Description | |
|---|---|---|
| Enabled |
Controls whether the tweaker is run during parsing. Default is true.
| |
| MessageReporter |
The default implementation stores the message reporter in a field.
| |
| Name |
The property contains a name for the file tweaker that can be overridden in derived classes. This name is used in error messages.
| |
| RequireValidEncoding |
This property governs whether the File Tweaker requires encoding information before it will tweak a file. This may be needed
to ensure that the file the tweaker uses the correct encoding.
|
| Name | Description | |
|---|---|---|
| Tweak |
This method should be overridden to provide an implementation of the processing
performed before the native file is parsed by the framework.
| |
| TweakFilePreParsing |
Default implementation of the INativeFileTweaker.TweakFilePreParsing method that will check to see if
the file will be tweaked (see WillFileBeTweaked), and whether the encoding has been
detected during sniffing if RequireValidEncoding is true and then call Tweak. Derived classes
should normally override the Tweak method instead.
| |
| WillFileBeTweaked |
This method can optionally be overridden to let the framework know whether the tweaking operation will actually
modify the file. This helps the framework know whether a backup of the file should be created and
can allow read-only files to be processed without error if no tweaking is required. By default, this
returns true.
|