Artboard 1
  • Integration
  • API Reference
  • Sdl.DesktopEditor.EditorApi.Implementation
  • DocumentStructureInfoColumn
Search Results for

    Show / Hide Table of Contents
    • Overview
    • Core
      • Plug-in Framework Overview
      • Plugin overview
        • Plug-in Resources and Localizability
        • The Plug-in Manifest Generator
        • Serialization Performance
      • Extensions and extension points
      • API Reference
        • Sdl.Core.Globalization
          • Codepage
          • ConfirmationLevel
          • Language
          • LanguageCancelEventArgs
          • LanguageEventArgs
          • LegacySdlxLanguage
          • LegacyTradosLanguage
          • LocalizableString
          • UnsupportedCodepageException
        • Sdl.Core.Globalization.LanguageRegistry
          • LanguageRegistryApi
        • Sdl.Core.PluginFramework
          • AuxiliaryExtensionAttribute
          • AuxiliaryExtensionAttributeCollection
          • DefaultObjectResolver
          • DefaultPluginLocator
          • DefaultPluginTypeLoader
          • ExtensionAttribute
          • ExtensionCollection
          • ExtensionEventArgs
          • ExtensionPointBehavior
          • ExtensionPointCollection
          • ExtensionPointInfoAttribute
          • FileBasedPluginDescriptor
          • IExtension
          • IExtensionAware
          • IExtensionPoint
          • InitializePluginCompletedEventArgs
          • InitializePluginProgressChangedEventArgs
          • InvalidSdlAssemblyReference
          • IObjectResolver
          • IPlugin
          • IPluginCache
          • IPluginDescriptor
          • IPluginFilter
          • IPluginInitializer
          • IPluginLocator
          • IPluginRegistry
          • IPluginStateHandler
          • IPluginTypeLoader
          • IThirdPartyPluginDescriptor
          • IValidatingPluginLocator
          • ObjectFactory
          • ObjectRegistry<TExtensionAttribute, TExtensionType>
          • PluginAttribute
          • PluginCollection
          • PluginFrameworkException
          • PluginId
          • PluginInitializationResult
          • PluginInitializationResultsEventArgs
          • PluginInitializedCallback
          • PluginLoadExceptionEventArgs
          • PluginManager
          • PluginResourceAttribute
          • PluginState
          • PluginStatus
          • SdlAssemblyReferenceError
          • ValidatingSystemPluginLocator
          • XmlPluginCache
        • Sdl.Core.PluginFramework.Configuration
          • ConfigManager
          • IFrameworkConfiguration
        • Sdl.Core.PluginFramework.Integration
          • ExtensionArguments
          • ExtensionBuilderAttribute
          • ExtensionsFactory
          • ExtensionsRepository
          • ExtensionStoreItem
          • IExtensionBuilder
          • ValuePairTypeInstance
        • Sdl.Core.PluginFramework.Util
          • ExtensionSorter
          • ITopologicalSortable
          • SortableExtensionAttribute
          • SortedObjectRegistry<TSortableExtensionAttribute, TExtensionType>
          • TopologicalExtensions
          • TopologicalSort<T>
        • Sdl.Core.PluginFramework.Validation
          • IExtensionAttributeInfo
          • IExtensionValidationContext
        • Sdl.Core.Settings
          • AbstractSettingsGroupBase
          • AbstractSettingsPage
          • ISettingsBundle
          • ISettingsBundleAware
          • ISettingsGroup
          • ISettingsPage
          • Setting<T>
          • SettingsChangedEventArgs
          • SettingsGroup
          • SettingsUtil
        • Sdl.Core.Settings.Implementation
          • AbstractSettingsBundleAware
          • SettingsGroupTypeDescriptionProvider
          • SettingsGroupTypeDescriptor
        • Sdl.Core.Settings.Implementation.Json
          • JsonSettingImpl<T>
          • JsonSettingsBundle
          • JsonSettingsGroup
        • Sdl.Core.Settings.Implementation.Xml
          • XmlSettingImpl<T>
    • File Type Support
      • Introduction to this SDK
        • File Type Framework Overview
        • What can you do with the File Type Support SDK?
        • How Translators Work
          • Opening a document for translation
          • Creating Projects
          • Merging files
          • Moving files between machines
          • File type settings
          • Using context information
          • Tag display modes
          • Using QuickInserts
          • Verifying files
          • Previewing files
          • Saving to different file types
        • Used Terminology
      • The File Type Support Framework
        • File Type Support - Overview
        • The Filter Component Builder
        • Extending the Filter Component Builder
        • The File Type Plug-in Lifecycle
        • What a File Type Plug-in Must Do
        • Creating a Native File Type Plug-in
          • The Theory
            • Overview of the Native API
            • The File Sniffer
            • The File Parser
            • The File Writer
            • The File Context
            • Native File Tweakers
            • Text Formattings
            • Reporting Problems
            • Filter UI Settings
            • Segmentation Hints
            • The Filter Preview
          • How to Create a Plug-in for Processing Native Formats
            • Introduction
            • Creating a New Project
            • Build the File Type Plug-in
            • The Resources File
            • Adding the File Type Component Builder
            • Implementing the File Sniffer
            • User Communication Through Messaging
            • Implementing the File Parser
            • Processing Inline Formatting
            • Implementing the File Writer
            • Implementing File Preview Functionality
              • Implementing an External File Preview
              • Implementing an Internal Preview
                • Introduction
                • Implementing a Static Preview
                  • Modifying the File Type Component Builder
                  • Implementing the Preview Writer
                • Implementing a Dynamic Real-time Preview
                  • Modifying the File Type Component Builder
                  • Enhancing the Preview File Writer
                  • Adding a Preview UI Control
                  • Adding a Preview Controller
                  • Appendix - Real-time Preview for XML Files
            • Further Enhance Your Plug-in
              • Introduction
              • Implementing QuickInsert Functionality
              • Locking Specific Strings
              • Loading and Saving the Settings
              • Creating a New Assembly for the Settings UI
              • Implementing the Settings UI
              • Implementing the UI Controller Class
              • Enhancing the File Parser to Process the Settings
              • Extending the Configuration Options
              • Processing Placeholder Tags
              • Handling Tags During Segmentation
              • Creating a Native File Tweaker
          • Sample Projects
        • Create a Bilingual File Type Plug-in
          • The Theory
            • Overview of the Bilingual API
            • The File Sniffer
            • The Bilingual File Parser
            • The Bilingual File Writer
            • IMarkupDataVisitor
            • Filter UI Settings
          • How to Create a Bilingual File Type Plug-in
            • Introduction
            • About the Example BIL Format
            • Creating a New Project
            • Adding the File Type Component Builder
            • Implementing the File Sniffer
            • Implementing the File Parser
              • Opening the File for Parsing
              • Outputting Segment Pairs
              • Processing Inline Tags
              • Applying Character Formatting
              • Applying the Segment Pair Confirmation Levels
              • Adding Context Information
              • Extracting Comments
              • Putting it all Together
            • Implementing the File Writer
              • Adding the File Writer Class
              • Adding the Text Extractor Class
              • Generating the Paragraph Units
              • Mapping the Segment Confirmation Levels
              • Outputting all Comments
        • Creating Sub Content Processors
          • Sub Content Overview
          • Sub Content Component Builder
          • The Main Parser
          • The Main Writer
          • The Sub Content Parser
          • The Sub Content Writer
          • Settings Page Example
      • The Verification Framework
        • How to Create a Native Verifier
          • Introduction
          • Create a New Project
          • Add a Resources File
          • Implement the User Interface
          • Loading and Saving the Settings
          • Implement the UI Controller Class
          • Implement the Verification Logic
          • Extending existing File Type Component Builder
        • How to Create a Bilingual Verifier
          • Introduction
          • Create a New Project
          • Add a Resources File
          • Implement the User Interface
          • Loading and Saving the Settings
          • Implement the UI Controller Class
          • Implement the Verification Logic
          • Create a New File Type Component Builder
        • How to Create a Global Verifier
          • Introduction
      • API Reference
        • Sdl.FileTypeSupport.Filters.Verifiers.GenericTagVerifier
          • GenericTagVerifier
          • GenericVerifierSettings
          • MatchedItem
        • Sdl.FileTypeSupport.Filters.Verifiers.GenericTagVerifier.Properties
          • Resources
        • Sdl.FileTypeSupport.Framework
          • Direction
          • FileJanitor
          • FileTypeDefinitionId
          • FileTypeSupportException
          • Pair<FirstType, SecondType>
          • TempFileManager
          • UserCancelledException
          • VersionInfo
        • Sdl.FileTypeSupport.Framework.BilingualApi
          • AbstractBilingualContentHandler
          • AbstractBilingualContentProcessor
          • AbstractBilingualFileTypeComponent
          • AbstractBilingualParser
          • BilingualContentMessageReporterProxy
          • DependencyFileLocator
          • IAbstractDataContent
          • IAbstractMarker
          • IAbstractMarkupData
          • IAbstractMarkupDataContainer
          • IAbstractTag
          • IBilingualContentHandler
          • IBilingualContentMessageReporter
          • IBilingualContentMessageReporterWithExtendedData
          • IBilingualContentProcessor
          • IBilingualDocumentFileWriter
          • IBilingualDocumentOutputProperties
          • IBilingualDocumentOutputPropertiesAware
          • IBilingualDocumentParser
          • IBilingualDocumentWriter
          • IBilingualFileTypeComponent
          • IBilingualParser
          • IBilingualToNativeConverter
          • IBilingualVerifier
          • IBilingualWriter
          • ICommentMarker
          • IDocumentItemFactory
          • IDocumentProperties
          • IFileProperties
          • ILocationMarker
          • ILockedContainer
          • ILockedContent
          • IMarkupDataVisitor
          • INativeToBilingualConverter
          • IOtherMarker
          • IParagraph
          • IParagraphUnit
          • IPlaceholderTag
          • IRepetitionsTable
          • IRevisionMarker
          • IRevisionProperties
          • ISegment
          • ISegmentPair
          • ISerializableMarkupDataContainer
          • IStructureTag
          • ISubSegmentReference
          • ITagPair
          • IText
          • LevelLocation
          • Location
          • NotSplittableException
          • RevisionType
          • TextLocation
        • Sdl.FileTypeSupport.Framework.Core.IntegrationApi
          • IFileTypeSettingsConverterComponentBuilder
          • IProjectAware
        • Sdl.FileTypeSupport.Framework.Core.Settings
          • AbstractFileTypeSettingsPage<SettingsControlType, SettingsType>
          • ComplexObservableList<T>
          • DeserializeFileInfo
          • FileSerializer
          • FileTypeSettingsBase
          • FileTypeSettingsPageAttribute
          • FontMappingRule
          • FontMappingSettings
          • FormattingGroupSettings
          • IAbstractSettingsPage
          • IFileTypeConfigurationAware
          • IFileTypeSettingsAware<SettingsType>
          • IFileTypeSettingsConverter
          • IFileTypeSettingsPage
          • ISerializableListItem
          • ObservableDictionary<TKey, TValue>
          • ObservableList<T>
        • Sdl.FileTypeSupport.Framework.Core.Settings.Constants
          • EncodingConstants
          • SettingsConstants
        • Sdl.FileTypeSupport.Framework.Core.Settings.JsonSettings
          • FileTypeSettingsJson
          • FileTypeSettingsUtil
        • Sdl.FileTypeSupport.Framework.Core.Settings.QuickInserts
          • BaseMarkupDataType
          • MarkupDataFactory
          • PlaceholderTagMarkup
          • QuickInsertSettings
          • QuickInsertsSettings
          • TagPairMarkup
          • TextMarkup
          • TextPairMarkup
        • Sdl.FileTypeSupport.Framework.Core.Settings.Serialization
          • AbstractSettingsClass
          • GenericFileTypeSettingsConverter
          • ISettingsClass
          • IValueGetter
          • IValueProcessor
          • SettingsBundleConverterMethod
          • SettingsFormatConverter
        • Sdl.FileTypeSupport.Framework.Core.Utilities
          • FileEncoding
          • PredicateAdapter<AdapteeType, TargetType>
        • Sdl.FileTypeSupport.Framework.Core.Utilities.AsposeLicense
          • AsposeLicenseEncoder
        • Sdl.FileTypeSupport.Framework.Core.Utilities.BilingualApi
          • BilingualContentHandlerAdapter
          • BufferedBilingualContentHandler
          • CharacterCountingIterator
          • CharacterCountingIterator.EndOfItemCharacterCounterVisitor
          • CharacterCountingIterator.ICharacterCountingVisitor
          • CharacterCountingIterator.StartOfItemCharacterCounterVisitor
          • CompleteHandler
          • Constants
          • DefaultDocumentItemFactory
          • EventFiringBilingualProcessor
          • ExistingContentHandling
          • FileCompleteHandler
          • InitializeHandler
          • InvalidEncodingRemovalVisitor
          • ParagraphUnitBuffer
          • ProcessParagraphUnitHandler
          • SetFilePropertiesHandler
          • SourceToTargetCopier
          • TextCollectionVisitor
        • Sdl.FileTypeSupport.Framework.Core.Utilities.Constants
          • Characters
        • Sdl.FileTypeSupport.Framework.Core.Utilities.Encryption
          • EncryptionConstants
        • Sdl.FileTypeSupport.Framework.Core.Utilities.Formatting
          • ColorUtilitesResources
          • ColorUtilities
          • FormattingGroup
          • FormattingInflator
          • FormattingItemFactory
          • FormattingStack
        • Sdl.FileTypeSupport.Framework.Core.Utilities.IntegrationApi
          • AbstractQuickTagBuilder
          • AlignmentDefaults
          • BilingualMessageLocation
          • Constants
          • DefaultFileTypeManager
          • DefaultQuickTagInfo
          • FilePathProvider
          • FolderPathProvider
          • Framework1ExternalPreviewException
          • QuickTagDefaults
        • Sdl.FileTypeSupport.Framework.Core.Utilities.NativeApi
          • AbstractFilePostTweaker
          • AbstractFilePreTweaker
          • DefaultPersistentFilePropertiesKeys
          • DefaultPropertiesFactory
          • DefaultTranslationOrigin
          • DefaultTranslationOriginPropertiesKeys
          • LengthTypes
          • LineNumberTracker
          • MetaDataTypes
          • RegExFilePostTweaker
          • RegExFilePreTweaker
          • SeverityTypes
          • StandardContextTypes
          • StandardContextTypes.ContextData
          • TMMatchContextTypes
          • TMTranslationOriginMetaData
        • Sdl.FileTypeSupport.Framework.Core.Utilities.NativeApi.Buffer
          • AbstractContentItem
          • ChangeContextContentItem
          • CommentEndContentItem
          • CommentStartContentItem
          • CustomInfoContentItem
          • InlineEndTagContentItem
          • InlinePlaceholderTagContentItem
          • InlineStartTagContentItem
          • LocationMarkContentItem
          • LockedContentEndContentItem
          • LockedContentStartContentItem
          • NativeBuffer
          • ParagraphComments
          • ParagraphUnitEndContentItem
          • ParagraphUnitStartContentItem
          • RevisionEndContentItem
          • RevisionStartContentItem
          • SegmentEndContentItem
          • SegmentStartContentItem
          • StructureTagContentItem
          • TextContentItem
        • Sdl.FileTypeSupport.Framework.Core.Utilities.Properties
          • Resources
        • Sdl.FileTypeSupport.Framework.Formatting
          • AbstractBooleanFormatting
          • AbstractFormattingItem
          • BackgroundColor
          • Bold
          • FontName
          • FontSize
          • IFormattingGroup
          • IFormattingItem
          • IFormattingItemFactory
          • IFormattingVisitor
          • Italic
          • Strikethrough
          • TextColor
          • TextDirection
          • TextPosition
          • TextPosition.SuperSub
          • Underline
          • UnknownFormatting
        • Sdl.FileTypeSupport.Framework.IntegrationApi
          • AbstractFileTypeDefinitionComponent
          • AbstractSingleFileRefreshablePreviewController
          • AbstractSourceAndTargetFileRefreshablePreviewController
          • BatchProgressEventArgs
          • BilingualDocumentOutputPropertiesProvider
          • BilingualParserFactory
          • BilingualVerifiersProvider
          • DynamicFilterComponentBuilder
          • ExtendedMessageEventData
          • FileNotSupportedException
          • FileTypeComponentBuilderAttribute
          • FileTypeComponentBuilderExtensionAttribute
          • FileTypeCreatorAttribute
          • FileTypeCreatorWizardPage
          • FileTypeDefinitionCustomizationLevel
          • FileTypeDefinitionNotFoundException
          • FileTypeProfile
          • GeneratorId
          • IAbstractGenerator
          • IAbstractPreviewApplication
          • IAbstractPreviewControl
          • IAbstractPreviewController
          • IAbstractUpdatablePreview
          • IAdditionalGeneratorsInfo
          • IApplicationPreviewType
          • IBilingualDocumentGenerator
          • IBilingualProcessorContainer
          • IconDescriptor
          • IControlPreviewType
          • IDefaultFileTypeSettingsProvider
          • IDefaultQuickTagInfo
          • IFileExtractor
          • IFileGenerator
          • IFileTypeComponentBuilder
          • IFileTypeComponentBuilderAdapter
          • IFileTypeCreator
          • IFileTypeDefinition
          • IFileTypeDefinitionAware
          • IFileTypeDefinitionConfiguringControl
          • IFileTypeDefinitionFactory
          • IFileTypeInformation
          • IFileTypeManager
          • IFilterFramework1FilterDefinitionFile
          • IGeneratorInfo
          • IInteractivePreviewComponent
          • IInteractivePreviewComponentFactory
          • IMessageLocation
          • IMultiFileConverter
          • INavigablePreview
          • IPreviewSet
          • IPreviewSets
          • IPreviewSetsFactory
          • IPreviewType
          • IPreviewUpdatedViaRefresh
          • IPreviewUpdatedViaSegmentFile
          • IQuickTag
          • IQuickTagContent
          • IQuickTags
          • IQuickTagsFactory
          • ISettingsAware
          • ISingleFilePreviewApplication
          • ISingleFilePreviewControl
          • ISingleFilePreviewController
          • ISingleFileRefreshablePreview
          • ISourceAndTargetFilePreviewApplication
          • ISourceAndTargetFilePreviewControl
          • ISourceAndTargetFilePreviewController
          • ISourceAndTargetFileRefreshablePreview
          • ISubContentComponentBuilder
          • ISubContentExtractor
          • ISubContentGenerator
          • IVerifierCollection
          • MessageEventArgs
          • NativeGeneratorProvider
          • NoDefaultBilingualFileTypeException
          • NotBilingualFileTypeException
          • OneOrMoreFilesNotSupportedException
          • OutputPropertiesProvider
          • PreviewApplicationId
          • PreviewClosedEventArgs
          • PreviewControlHandler
          • PreviewControlId
          • PreviewSetId
          • PreviewSetKind
          • QuickTagDefaultId
          • SegmentReference
          • SegmentSelectedEventArgs
          • SubContentProcessorDoesNotExistException
          • TemplateComponentBuilderManager
          • UnknownFileTypeDefinitionException
        • Sdl.FileTypeSupport.Framework.IntegrationApi.Implementation
          • FileTypeCreator
        • Sdl.FileTypeSupport.Framework.IntegrationApi.QuickInserts
          • IQuickInsert
          • IQuickInsertDefinitionsManager
          • IQuickInsertsBuilder
          • QuickInsertConstants
          • QuickInsertIds
        • Sdl.FileTypeSupport.Framework.NativeApi
          • AbstractNativeExtractionContentProcessor
          • AbstractNativeExtractionGenerationContentProcessor
          • AbstractNativeFileParser
          • AbstractNativeFileParser.Stage
          • AbstractNativeFileTypeComponent
          • AbstractNativeFileWriter
          • AbstractNativeGenerationContentProcessor
          • ConflictingIdException
          • ContentRestriction
          • ContextPurpose
          • DependencyFileLinkOption
          • DependencyFileUsage
          • DetectionLevel
          • EncodingCategory
          • ErrorLevel
          • FileId
          • IAbstractBasicTagProperties
          • IAbstractInlineTagProperties
          • IAbstractNativeContentHandler
          • IAbstractTagProperties
          • IBasicMessageReporter
          • IBasicMessageReporterWithExtendedData
          • ICacheableSubContentParser
          • ICacheableSubContentWriter
          • IComment
          • ICommentProperties
          • IContextInfo
          • IContextProperties
          • ICustomInfoProperties
          • IdConflictResolution
          • IDependencyFileProperties
          • IEndTagProperties
          • IFilePostTweaker
          • IFilePreTweaker
          • IFileTweaker
          • ILockedContentProperties
          • IMetaDataContainer
          • INativeContentCycleAware
          • INativeContentStreamMessageReporter
          • INativeExtractionContentHandler
          • INativeExtractionContentProcessor
          • INativeExtractor
          • INativeFileParser
          • INativeFileSniffer
          • INativeFileTypeComponent
          • INativeFileVerifier
          • INativeFileWriter
          • INativeGenerationContentHandler
          • INativeGenerationContentProcessor
          • INativeGenerator
          • INativeLocationTracker
          • INativeOutputFileProperties
          • INativeOutputSettingsAware
          • INativeSubContentExtractor
          • INativeSubContentGenerator
          • INativeTextLocationMessageReporter
          • IOutputFileInfo
          • IParagraphUnitProperties
          • IParser
          • IPersistentFileConversionProperties
          • IPlaceholderTagProperties
          • IPropertiesFactory
          • ISegmentPairProperties
          • ISharedObjects
          • ISharedObjectsAware
          • IStartTagProperties
          • IStructureInfo
          • IStructureTagProperties
          • ISubContentAware
          • ISubContentParser
          • ISubContentPublisher
          • ISubContentWriter
          • ISubSegmentProperties
          • ISupportsPersistenceId
          • ISupportsUniqueId
          • ITextProperties
          • ITranslationOrigin
          • LocationMarkerId
          • LockTypeFlags
          • NativeTextLocation
          • ParagraphUnitId
          • ProcessSubContentEventArgs
          • ProgressEventArgs
          • ProgressReporter
          • RepetitionId
          • RevisionTypeNotSupportedException
          • SegmentationHint
          • SegmentId
          • Severity
          • SharedObjectPublishedEventArgs
          • SniffInfo
          • SourceCount
          • SourceCount.CountUnit
          • TagId
          • TextContextMatchLevel
        • Sdl.FileTypeSupport.Framework.PreviewControls
          • AbstractNativePreviewFileWriter
          • AbstractPreviewControl
          • DualBrowserControl
          • GenericExteralPreviewApplication
          • GenericInternalWebBrowserPreviewControl
          • GenericSideBySideWebBrowserPreviewControl
          • ITempFileProperties
          • MsOfficeExternalPreviewApplication
          • NavigableDualBrowserControl
          • SideBySideNavigableWebBrowserPreviewController
          • SideBySideRealtimeWebBrowserPreviewController
          • TempFileProperties
          • TempFileUtils
    • Project Automation
      • Overview
      • Threading Support
      • Working with projects
        • Overview
        • About projects
        • About Project Files
        • Project Configuration
        • About Project Translation Memories
        • About Tasks
        • About Packages
        • About Server-Based Projects
        • Code Examples
          • Required References and Namespaces
          • Creating a New Project
            • Setting the Project Information
            • Adding Files and Folders
            • Adding Translation Memories
            • Adding Termbases
            • Running Tasks on the Project Files
            • Saving Task Reports
            • Automatic Tasks and Task Settings
              • Analyze Files Settings
              • Project TM Creation Settings
              • Perfect Match
              • Pre-Translate Settings
              • Update Translation Memory Settings
              • Generating and Exporting Target Files
              • Translation Count
            • Translation Memory Settings
              • Translation Memory Search Settings
              • Setting TM Penalties
              • Auto-Substitution Settings
              • Translation Memory Field Update
              • Translation Memory Filter Settings
            • Working with Project Reports
            • Creating Projects Based on Previous Projects
            • Creating Projects Based on Templates
            • Creating a Merged File
            • Updating Project Files
            • Retrieving the Project Statistics
            • Deleting Projects
            • Completing Projects
            • Packages
              • Creating a Project Package
              • Creating a Return Package
              • Importing a Return Package
          • Working with a Project Server
            • Connecting a Project to a Project Server
            • Synchronizing With Project Server
            • Viewing and Deleting Published Projects
            • Checking Files In and Out
            • Downloading and Uploading Files
            • Putting it All Together
        • Developing a Sample Application
          • Introduction to the Sample Application
          • Setting up the Visual Studio Project
          • The Command-line Parameters
          • Configuring the Project Properties
          • Adding Files in the Folder to the Project
          • Adding the TM to the Project
          • Converting the Project Files
          • Analyzing the Files
          • Configuring the Analyze Task Settings
          • Generating the Task Report
          • Publishing to a Server
          • Deleting the Project
          • Putting it All Together
      • API Reference
        • Sdl.ProjectAutomation.Core
          • AnalysisBand
          • AnalysisStatistics
          • AutomaticTask
          • AutomaticTaskTemplateIds
          • BilingualFileMapping
          • CombinedConfirmationLevel
          • CommonFileExtensions
          • ConfirmationStatistics
          • CountData
          • DataTransferEventArgs
          • ExecutionMessage
          • ExtensionMethods
          • FileRole
          • FuzzyCountData
          • IPackage
          • IProject
          • IProjectDeleteOperation
          • LocalFileState
          • LocalTermbase
          • ManualTask
          • MergedProjectFile
          • MergeState
          • MessageEventArgs
          • MessageLevel
          • PackageOperation
          • PackageStatus
          • PackageStatusEventArgs
          • ProgressEventArgs
          • ProjectAutomationException
          • ProjectFile
          • ProjectFileTypeConfiguration
          • ProjectFileVersion
          • ProjectInfo
          • ProjectPackageCreation
          • ProjectPackageCreationOptions
          • ProjectPackageImport
          • ProjectReference
          • ProjectStatistics
          • ProjectStatus
          • ProjectTemplateInfo
          • ProjectTemplateReference
          • ProjectTranslationMemoryPackageOptions
          • ProjectType
          • PublicationStatus
          • ReportFormat
          • ReturnPackageCreation
          • ReturnPackageImport
          • ServerTermbase
          • TargetLanguageStatistics
          • Task
          • TaskFile
          • TaskFileInfo
          • TaskMessageEventArgs
          • TaskReport
          • TaskSequence
          • TaskStatus
          • TaskStatusEventArgs
          • Termbase
          • TermbaseConfiguration
          • TermbaseLanguageIndex
          • TermbaseSearchOrder
          • TermRecognitionOptions
          • TranslationProviderCascadeEntry
          • TranslationProviderConfiguration
          • TranslationProviderReference
          • ValueStatus
          • WordCountStatistics
        • Sdl.ProjectAutomation.FileBased
          • AbstractContentProcessor
          • AbstractContentTask
          • FileBasedProject
          • LicensingException
          • ProjectCredentials
          • ProjectEvent
          • ProjectServer
          • PublishProjectEventArgs
          • PublishProjectResult
          • ServerProjectInfo
          • TaskSequences
        • Sdl.ProjectAutomation.FileBased.Events
          • ProjectCreatedEvent
          • ProjectOpenedEvent
          • ProjectPublishedEvent
        • Sdl.ProjectAutomation.FileBased.Reports.Models
          • Report
          • ReportDefinition
        • Sdl.ProjectAutomation.FileBased.Reports.Operations
          • ProjectReportsOperations
        • Sdl.ProjectAutomation.FileBased.ServerOperations
          • IServerBasedProjectOperations
          • ServerBasedProjectOperations
        • Sdl.ProjectAutomation.Settings
          • AbstractTaskSettings
          • AnalysisTaskSettings
          • AppendToUnitType
          • BatchProcessingGeneralSettings
          • ExportFilesSettings
          • ExportFileVersion
          • ExportForReviewTaskSettings
          • ExternalReviewMappingItem
          • ImportFromReviewTaskSettings
          • MeasurementsFormattingMode
          • NoTranslationMemoryMatchFoundAction
          • PerfectMatchTaskSettings
          • ProjectSettings
          • ProjectTranslationMemoryTaskSettings
          • PseudoTranslateSettings
          • ReturningPackageSettings
          • SourceTrackChangesLookupMode
          • TmImportOption
          • TranslateTaskSettings
          • TranslationCountSettings
          • TranslationMemorySettings
          • TranslationMemoryUpdateTaskSettings
          • TranslationUpdateMode
          • WordCountSettings
        • Sdl.ProjectAutomation.Settings.CustomAttributes
          • CDataWrapper
          • CustomAttribute
          • CustomAttributeList
          • CustomAttributeSettings
          • CustomAttributeTypeEnum
        • Sdl.ProjectAutomation.Settings.Events
          • TranslationProviderStatusChanged
    • Translation Memory
      • Introduction
      • General
        • What you can do with this SDK
        • How Translators Work with Translation Memories
          • Creating Translation Memories
          • Configuring Translation Memories
          • Accessing Translation Memories
          • Performing Translation Memory Lookups
          • Updating Translation Memories
          • Maintaining Translation Memories
      • Working with Translation Memories
        • General
          • Introduction
          • Working with File-based Translation Memories
          • Working with Field Definitions
          • Working with Language Resources
          • Importing Content into a Translation Memory
          • Exporting Content from a Translation Memory
          • Performing Translation Memory Lookups
          • Working with Filters
        • Code Examples
          • Required References and Namespaces
          • Setting up File Translation Memories
            • Creating a File-based Translation Memory
            • Setting and Retrieving TM Properties
            • Adding TM Fields
            • Adding Language Resources
            • Setting Translation Memory Access Rights
          • Importing a TMX File
          • Exporting to a TMX File
          • Doing Translation Memory Lookups
          • Updating a Translation Memory
          • Reading Translation Unit System Information
          • Tuning and Maintaining a Translation Memory
          • Looping through Translation Memories
      • Working with TM Server
        • General
          • Introduction
          • Connecting to TM Server
          • Working with Database Servers and Containers
          • Working with Server-based Translation Memories
          • Working with Field Templates
          • Working with Language Resource Templates
          • Performing a Scheduled Import or Export
        • Code Examples
          • Introduction
          • Preparing your Project for Server Access
          • Connecting to a TM server
          • Retrieving Licensing Information
          • Retrieving Database Servers
          • Retrieving TM Containers
          • Creating a Container Database
          • Creating a Server Translation Memory
          • Scheduled TMX Imports
          • Scheduled TMX Exports
          • TM Fields Templates
          • Language Resource Templates
      • Translation Provider Plug-ins
        • Introduction
        • Creating the Translation Provider
        • Creating the Translation Provider Factory
        • Creating the Translation Provider UI Extension
      • Sample Projects
        • TM Batch Export Tool
          • Introduction to the TM Batch Export Tool
          • Setting up the Project
          • Looping through the Folder(s)
          • Exporting to TMX
        • TM Batch Import Tool
          • Introduction to the TM Batch Import Tool
          • Setting up the Project
          • Looping through the Folder(s)
          • Importing into the Master Translation Memories
          • Creating the Master Translation Memories
          • Creating a Log File
        • TM Lookup Tool
          • Introduction to the TM Lookup Tool
          • Setting up the Project
          • Adding the Main GUI
          • Adding the Server TM Selection Form
          • Adding the Search Settings Form
          • Adding the Connector Class
          • Implementing the Search Functionality
        • Creating a Translation Service Provider Plug-in
          • About the Sample Translation Service Provider Plug-in
          • Setting up the Project
          • The Resources File
          • The Plug-in Manifest
          • Building the Plug-in
          • Instantiating the Plug-in
          • Implementing the Plug-in User Interface
          • Controlling the Plug-in User Interface
          • Storing and Retrieving the Plug-in Settings
          • Enabling the Required Translation Provider Features
          • Verifying the Language Pair Support
          • Implementing the Search Logic
          • Implementing the Element Visitor
      • API Reference
        • Sdl.Core.FineGrainedAlignment
          • AlignableContentPairId
          • AlignableCorpusId
          • AlignedPhrase
          • AlignerDefinition
          • AlignerSettings
          • AlignmentEvidence
          • AlignResult
          • BilingualChiSquareComputer3
          • BilingualPhraseComputer3
          • BilingualPhraseComputer3.Settings
          • ChiSquaredAligner
          • ChiSquaredAligner.CodedTokenIndexConverter
          • ChiSquaredAligner.NullModelException
          • ChiSquaredLiftAligner
          • ChiSquaredTranslationModel
          • ChiSquaredTranslationModelBuilder
          • ChiSquaredTranslationModelId
          • ChiSquaredTranslationModelStoreReadOnly
          • CooccurrenceCounter2
          • FGAInitializer
          • IAlignableContentPair
          • IAlignableCorpus
          • IAlignableCorpusAsync
          • IAlignableCorpusManager
          • IAlignableCorpusManagerAsync
          • IAlignerBroker
          • IAlignerService
          • IChiSquaredTranslationModelStore
          • IChiSquaredTranslationModelStoreReadOnly
          • IFineGrainedAligner
          • IPairEnumerator
          • ITranslationModelDataService
          • ITranslationModelManagementService
          • ITranslationModelManager
          • LiftAligner
          • LiftAligner.SpanHypothesis
          • LiftAligner.SpanHypothesisArray
          • ModelBasedAlignerDefinition
          • ModelNotFoundException
          • OnlineAlignerDefinition
          • SimpleAlignerBroker
          • SimpleAlignmentEvidence
          • TokenWithCount
          • TrainedModelAligner
          • TrainedModelAligner.CodedTokenIndexConverter
          • TrainedModelBuildResults
          • TrainedTranslationModel
          • TrainedTranslationModelBuilder
          • TrainedTranslationModelId
          • TranslationModel
          • TranslationModelBuilderSettings
          • TranslationModelCancelException
          • TranslationModelDetails
          • TranslationModelException
          • TranslationModelFitness
          • TranslationModelId
          • TranslationModelProgressEventArgs
          • TranslationModelProgressStage
          • TranslationModelTypes
          • VocabularyFile3
          • WordAlignmentComputer3
        • Sdl.Core.FineGrainedAlignment.Model
          • TranslationModelMatrixEntry
          • TranslationModelTuMatrixRequest
          • TranslationModelVocabEntry
        • Sdl.Core.LanguageProcessing.Tokenization
          • SeparatorCombination
        • Sdl.Core.TM.ImportExport
          • BatchExportedEventArgs
          • BatchImportedEventArgs
          • Exporter
          • ExporterAsync
          • IExportOrigin
          • IExportOriginAsync
          • IImportDestination
          • IImportDestinationAsync
          • Importer
          • ImporterAsync
          • ImporterAsync.ImportResultsMap
          • ImportExportResponse
          • LanguageMismatchException
          • TmApiImportExport
        • Sdl.LanguagePlatform.Core
          • CharacterProperties
          • CharacterProperties.Case
          • CharacterSet
          • CultureInfoExtensions
          • CultureInfoExtensions.LanguageGroupID
          • CultureInfoExtensions.LanguageGroupInstallationStatus
          • CultureString
          • DateTimeUtilities
          • ErrorCode
          • FaultDescription
          • FaultStatus
          • ISegmentElementVisitor
          • LanguagePair
          • LanguagePlatformException
          • Pair<T>
          • SearchOption
          • Segment
          • Segment.DeleteTagsAction
          • Segment.ValidationMode
          • SegmentEditor
          • SegmentElement
          • SegmentElement.Similarity
          • SegmentPosition
          • SegmentRange
          • StringUtilities
          • StringUtilities.Casing
          • Tag
          • TagType
          • Text
          • UnicodeBlock
          • Wordlist
        • Sdl.LanguagePlatform.Core.EditDistance
          • EditDistance
          • EditDistanceItem
          • EditDistanceResolution
          • EditOperation
        • Sdl.LanguagePlatform.Core.Resources
          • IResourceDataAccessor
          • IResourceDataAccessorAsync
          • LanguageResourceType
          • ResourceDataAccessorAsyncWrapper
          • ResourceStatus
        • Sdl.LanguagePlatform.Core.Segmentation
          • Context
          • ContextType
          • LocalizedString
          • RuleOrigin
          • RuleType
          • SegmentationContext
          • SegmentationRule
          • SegmentationRules
        • Sdl.LanguagePlatform.Core.Serialization
          • LinguaDeserializer
        • Sdl.LanguagePlatform.Core.Tokenization
          • AutoLocalizationSettings
          • BuiltinRecognizers
          • CurrencyFormat
          • CurrencySymbolPosition
          • CustomUnitDefinition
          • DateTimePatternType
          • DateTimeToken
          • GenericPlaceableToken
          • ILocalizableToken
          • LocalizationParametersSource
          • Match
          • MeasureToken
          • NumberToken
          • NumericSeparator
          • PrioritizedToken
          • Sign
          • SimpleToken
          • TagToken
          • Token
          • TokenBundle
          • TokenizationContext
          • TokenizerFlags
          • TokenType
          • Unit
          • UnitSeparationMode
        • Sdl.LanguagePlatform.IO
          • MultiFileTextReader
        • Sdl.LanguagePlatform.IO.Streams
          • CommentEvent
          • EndOfInputEvent
          • Event
          • IEventReader
          • IEventReceiver
          • StartOfInputEvent
          • TUEvent
          • TUStreamContext
        • Sdl.LanguagePlatform.IO.TMX
          • body
          • bpt
          • ept
          • header
          • headerSegtype
          • hi
          • it
          • itPos
          • map
          • note
          • ph
          • prop
          • seg
          • sub
          • tmx
          • TMXReader
          • TMXReaderSettings
          • TMXStartOfInputEvent
          • TMXTools
          • TMXWriter
          • TMXWriterSettings
          • tu
          • tuSegtype
          • tuv
          • ude
          • ut
        • Sdl.LanguagePlatform.TranslationMemory
          • Action
          • AdaptiveMachineTranslationLookupMode
          • AppliedPenalty
          • AtomicExpression
          • AtomicExpression.Operator
          • ComposedExpression
          • ComposedExpression.Operator
          • DateTimeFieldValue
          • DocumentDetail
          • DuplicateIterator
          • DuplicateIterator.DuplicateIteratorPosition
          • ExportSettings
          • ExportStatistics
          • FGASupport
          • Field
          • FieldDefinitions
          • FieldIdentifier
          • FieldType
          • FieldValue
          • FieldValues
          • FieldValueType
          • Filter
          • FilterExpression
          • FilterExpressionParser
          • FuzzyIndexes
          • FuzzyIndexTuningSettings
          • IField
          • IFieldDefinitions
          • IFieldValueComparer<T>
          • ILogLogger
          • ImportResult
          • ImportResults
          • ImportSettings
          • ImportSettings.FieldUpdateMode
          • ImportSettings.ImportTUProcessingMode
          • ImportSettings.NewFieldsOption
          • ImportSettings.TUUpdateMode
          • ImportStatistics
          • ImportStatus
          • IntFieldValue
          • ITypedKeyValueContainer
          • LogManager
          • MachineTranslationLookupMode
          • MultiplePicklistFieldValue
          • MultipleStringFieldValue
          • NLogLogger
          • Penalty
          • PenaltyType
          • PersistentObject
          • PersistentObjectToken
          • PicklistField
          • PicklistItem
          • PicklistItems
          • Placeable
          • PlaceableAssociation
          • PlaceableComputer
          • PlaceableType
          • RegularIterator
          • ScoringResult
          • SearchMode
          • SearchResult
          • SearchResultFieldValueAccessor
          • SearchResultFieldValueComparer
          • SearchResults
          • SearchResults.SearchResultComparer
          • SearchResultsMerged
          • SearchSettings
          • SegmentAndSubsegmentSearchResults
          • SegmentAndSubsegmentSearchResultsMerged
          • SegmentSerializer
          • SinglePicklistFieldValue
          • SingleStringFieldValue
          • SortCriterium
          • SortDirection
          • SortDisambiguator
          • SortDisambiguator.Disambiguator
          • Sorter<T>
          • SortSpecification
          • SubsegmentMatchType
          • SubsegmentSearchCondition
          • SubsegmentSearchResult
          • SubsegmentSearchResults
          • SubsegmentSearchResultsCollection
          • SubsegmentSearchSettings
          • SystemFields
          • SystemFieldsKeys
          • SystemFieldsParameters
          • TextContextMatch
          • TextContextMatchType
          • TranslationMemoryIterator
          • TranslationMemoryProgress
          • TranslationUnit
          • TranslationUnitFormat
          • TranslationUnitOrigin
          • TuContext
          • TuContexts
          • TuIdContexts
          • TuLimitsValidatorSettings
          • Utilities
          • WordCountFlags
          • WordCounts
          • WordCountsOptions
        • Sdl.LanguagePlatform.TranslationMemory.EditScripts
          • Continuation
          • EditAction
          • EditActionChangeFieldValue
          • EditActionDeleteAllFieldValues
          • EditActionDeleteFieldValue
          • EditActionDeleteTags
          • EditActionRenameField
          • EditActionSearchReplace
          • EditScript
          • EditScriptApplier
          • EditUpdateMode
          • Mode
          • PatternType
        • Sdl.LanguagePlatform.TranslationMemoryApi
          • AbstractLocalTranslationMemory
          • AbstractMachineTranslationProvider
          • AbstractMachineTranslationProviderLanguageDirection
          • AlignmentTMBilingualProcessor
          • BatchExportedEventArgs
          • BatchImportedEventArgs
          • Cascade<T>
          • CascadeEntry
          • CascadeException
          • CascadeMessage
          • CascadeMessageCode
          • DatabaseServer
          • DatabaseServerAuthenticationType
          • DatabaseServerPermissions
          • DatabaseServerType
          • DefaultLanguageResourceProvider
          • FieldDefinition
          • FieldDefinitionCollection
          • FileBasedLanguageResourcesTemplate
          • FileBasedTranslationMemory
          • FileBasedTranslationMemoryLanguageDirection
          • FileTransferEventArgs
          • GenericCredentials
          • IAdvancedContextTranslationMemory
          • IAdvancedContextTranslationMemoryLanguageDirection
          • IAlignableTranslationMemory
          • IFieldsTemplate
          • IFileBasedTranslationMemory
          • ILanguageResourceEntity
          • ILanguageResourcesTemplate
          • ILocalTranslationMemory
          • ImportExportOperationBase
          • InMemoryTranslationMemory
          • IPermissionCheck
          • IReindexableTranslationMemory
          • ISubsegmentTranslationMemoryLanguageDirection
          • ISupportPlaceables
          • ITranslationMemory
          • ITranslationMemory2015
          • ITranslationMemoryLanguageDirection
          • ITranslationProvider
          • ITranslationProviderCredentialStore
          • ITranslationProviderFactory
          • ITranslationProviderLanguageDirection
          • ITranslationProviderLanguageDirectionWithDelete
          • ITranslationProviderSummaryFactory
          • ITranslationProviderWinFormsUI
          • LanguageResourceBundle
          • LanguageResourceBundleCollection
          • LanguageResourceEntity
          • LicensingStatusInformation
          • NullPropertyException
          • ObjectDeletedException
          • ObjectDoesNotExistException
          • ObjectNotSavedException
          • PagedTranslationMemories
          • PicklistItemDefinition
          • PicklistItemDefinitionCollection
          • PropertyValueValidator
          • ProviderStatusInfo
          • RemoteTranslationMemory
          • ScheduledOperation
          • ScheduledOperationStatus
          • ScheduledRecomputeStatisticsOperation
          • ScheduledReindexOperation
          • ScheduledServerTranslationMemoryExport
          • ScheduledServerTranslationMemoryImport
          • ServerBasedFieldsTemplate
          • ServerBasedLanguageResourcesTemplate
          • ServerBasedTranslationMemory
          • ServerBasedTranslationMemoryLanguageDirection
          • ServerBasedTranslationMemoryLanguageDirectionCollection
          • ServerImportStatus
          • StringResources
          • SystemFieldDefinitions
          • TranslationMemoryContainer
          • TranslationMemoryContainerPermissions
          • TranslationMemoryExporter
          • TranslationMemoryFieldsPermissions
          • TranslationMemoryFileAccessMode
          • TranslationMemoryImporter
          • TranslationMemoryLanguageResourcePermissions
          • TranslationMemoryPermissions
          • TranslationMemoryProperties
          • TranslationMemoryQuery
          • TranslationMemorySearchResultConverters
          • TranslationMemoryUpgradeUtil
          • TranslationMethod
          • TranslationProviderAuthenticationException
          • TranslationProviderCascadePermissions
          • TranslationProviderCredential
          • TranslationProviderCredentialStore
          • TranslationProviderDisplayInfo
          • TranslationProviderFactoryAttribute
          • TranslationProviderInfo
          • TranslationProviderManager
          • TranslationProviderServer
          • TranslationProviderUriBuilder
          • TranslationProviderWinFormsUiAttribute
          • TranslationUnitPermissions
        • Sdl.LanguagePlatform.TranslationMemoryApi.Helpers
          • FileBasedTMSettingsCloner
        • Sdl.LanguagePlatform.TranslationMemoryApi.Upgrade
          • AbstractTranslationMemoryCreator
          • BaseTranslationMemoryMigrationManager
          • IBaseTranslationMemoryMigrationManager
          • IExportableLegacyTranslationMemory
          • IFieldIdentifierMappings
          • IFieldIdentifierMappingsCollection
          • IFileBasedTranslationMemoryCreator
          • IInputLanguageDirectionData
          • IInputLanguageDirectionDataCollection
          • IInputTranslationMemory
          • IInputTranslationMemoryCollection
          • IItemCollection<T>
          • ILegacyLanguageDirectionData
          • ILegacyLanguageResources
          • ILegacyTranslationMemory
          • ILegacyTranslationMemorySetup
          • IMigrationProject
          • InputLanguagePair
          • InputLanguagePairCollection
          • IOutputTranslationMemory
          • IOutputTranslationMemoryCollection
          • ItemCollection<T>
          • ItemCollectionAddedEventArgs<T>
          • ItemCollectionEventArgs<T>
          • ItemCollectionRemovedEventArgs<T>
          • ITmxLegacyTranslationMemory
          • ITranslationMemoryCreator
          • ITranslationMemoryExporter
          • ITranslationMemorySetupOptions
          • LegacyLanguage
          • LegacyLanguagePair
          • LegacyTranslationMemorySetup
          • ProgressEventArgs
          • TmxFileStatus
    • Integration
      • Overview
      • What you can do with the Integration API
      • User Interface integration
        • Introduction
        • Creating views
        • Creating viewparts
        • Creating ribbon groups
        • Creating actions
        • Adding custom steps to wizards
        • Samples
          • Integrating views
          • Integrating viewparts
          • Integrating ribbon groups
          • Integrating actions
          • Reference Sample
          • Content Connector
          • Project Creator
          • Wikipedia Search
          • Implementing a custom job
      • Trados Studio Automation
        • Introduction
        • Create a Trados Studio application initializer
        • Create a Trados Studio AutoSuggest provider
        • Create command line processors
        • Trados Studio controllers
          • Introduction
          • Projects controller
          • Files controller
          • Editor controller
        • Extend default packaging functionality
        • Integration Samples
          • Trados Studio application initializers
          • Trados Studio AutoSuggest provider
          • Trados Studio command line processor
          • Using Trados Studio ProjectsController
          • Using Trados Studio FilesController
          • Using Trados Studio EditorController
          • Customizing the Open Package Wizard Sample
          • Customizing the Create Return Package Wizard Sample
          • Processing custom project package formats
      • Bilingual API
        • Overview
        • Traversing document entities
      • Display Filter
        • Introduction
        • Developing a Sample Custom Display Filter
          • What the filter should do
          • Setting up the Visual Studio Project
          • Implementing filtering capabilities to your Display Filter
          • Creating the UI Editor Control for your Display Filter
      • API Reference
        • Sdl.Desktop.IntegrationApi
          • AbstractAction
          • AbstractApplication
          • AbstractRibbonGroup
          • AbstractViewController
          • AbstractViewControllerAction<TController>
          • AbstractViewPartController
          • ActionExecutionCancelEventArgs
          • ActionExecutionEventArgs
          • ActivationChangedEventArgs
          • ApplicationHost<T>
          • DefaultSettingsPage<TControl, TSettings>
          • IApplicationInitializer
          • ISettingsAware<TSettings>
          • IViewContext
          • SettingsBinder
          • VisibilityChangedEventArgs
        • Sdl.Desktop.IntegrationApi.DefaultLocations
          • StudioDefaultContextMenus
          • StudioDefaultRibbonGroups
          • StudioDefaultRibbonTabs
          • StudioDefaultRibbonTabs.AddinsRibbonTabLocation
          • StudioDefaultRibbonTabs.HelpRibbonTabLocation
          • StudioDefaultRibbonTabs.ViewRibbonTabLocation
          • StudioDefaultViews
        • Sdl.Desktop.IntegrationApi.Extensions
          • AbstractCommandBarItemAttribute
          • AbstractLayoutAttribute
          • AbstractLayoutConfiguration
          • ActionAttribute
          • ActionLayoutAttribute
          • ApplicationInitializerAttribute
          • DisplayType
          • DockType
          • GroupStyle
          • ILocationAware
          • RibbonGroupAttribute
          • RibbonGroupLayoutAttribute
          • ShortcutAttribute
          • ViewAttribute
          • ViewPartAttribute
          • ViewPartLayoutAttribute
        • Sdl.Desktop.IntegrationApi.Extensions.CommandLine
          • ExternalCommandLineArgument
          • ExternalCommandLineArgumentDefinition
          • ExternalCommandLineArguments
          • ExternalCommandLineProcessorAttribute
          • IExternalCommandLineProcessor
          • IExternalWindowAwareCommandLineProcessor
        • Sdl.Desktop.IntegrationApi.Extensions.Internal
          • AbstractController
          • AbstractLocation
          • ActionProperties
          • ActionPropertyChangedEventArgs
          • ActionStyle
          • BindActionAttribute
          • BindControllerAttribute
          • IAction
          • IBindedController
          • PluginTargetCommandBarSiteType
        • Sdl.Desktop.IntegrationApi.Interfaces
          • IPluginLog
          • IPluginLoggerFactory
          • IStudioEventAggregator
          • IStudioGroupNotification
          • IStudioNotification
          • IStudioNotificationCommand
          • IUIControl
          • IUISettingsControl
        • Sdl.Desktop.IntegrationApi.Internal
          • AbstractBindedAction
          • AbstractBindedController
          • DefaultExplorerBar
        • Sdl.Desktop.IntegrationApi.Jobs
          • ExecuteExternalJobEvent
          • IExternalJob
          • IExternalJobExecutionContext
          • IExternalJobWithProgress
          • JobFinishedArgs
          • JobProgressArgs
        • Sdl.Desktop.IntegrationApi.Notifications.Events
          • AddStudioGroupNotificationEvent
          • AddStudioNotificationOrCreateGroupEvent
          • AddStudioNotificationToGroupEvent
          • RemoveStudioGroupNotificationEvent
          • RemoveStudioNotificationFromGroupEvent
          • ShowStudioNotificationsViewEvent
          • StudioWindowCreatedNotificationEvent
        • Sdl.Desktop.IntegrationApi.Wizard
          • IStudioWizardPage
          • StudioWizardPage
        • Sdl.Desktop.Platform.Controls.Behaviours
          • ComboboxPlaceholderBehavior
          • DataGridItemBehavior
          • DragDropBehaviour
          • EventBehaviourFactory
          • FocusOnClickBehaviour
          • HighlightOnValueChanged
          • KeyboardFocusBehaviour
          • NumberOnlyBehaviour
          • PlaceholderAdorner
          • ShowSystemMenuBehavior
          • TextBlockAutoToolTipBehavior
          • TextBoxPlaceholderBehavior
          • TimedAutoHideBehaviour
          • TreeViewBringIntoViewWhenSelectedBehavior
          • TreeViewSelectedItemChangedBehaviour
          • WebBrowserBindableSourceBehavior
          • WebBrowserContentSource
          • WindowDragBehavior
          • WindowLoadedBehaviour
        • Sdl.Desktop.Platform.Controls.Browser
          • EmbeddedBrowserCookieManager
          • ICookieManager
          • INativeBrowserApi
          • NativeBrowserApi
          • WebBrowserExtensions
        • Sdl.Desktop.Platform.Controls.Controls
          • BindablePasswordBox
          • ButtonsAlignment
          • ComboBoxTreeViewWithNewItem
          • ComboBoxWithNewItem
          • CustomProgressRing
          • DataGridWithMultipleSelection
          • FeedbackControl
          • ManagerViewFeedback
          • NumericUpDown
          • NumericUpDownChangedRoutedEventArgs
          • NumericUpDownChangedRoutedEventHandler
          • ProgressBarWithPercentageText
          • SortWiseDataGrid
          • UniformWrapPanel
          • WindowsControlUtils
        • Sdl.Desktop.Platform.Controls.Controls.CustomTreeViewComboBox
          • ComboBoxTreeView
          • ExtendedTreeView
          • ExtendedTreeViewItem
          • ITreeViewItemModel
        • Sdl.Desktop.Platform.Controls.Controls.MenuControlComboBox
          • IsFor
          • MenuControl
          • MenuControlCommandModel
          • MenuControlCommandModelList
          • MenuItemControl
          • MenuScope
          • MenuType
        • Sdl.Desktop.Platform.Controls.Controls.WatermarkTextBox
          • TextBoxWatermarkHelper
        • Sdl.Desktop.Platform.Controls.Converters
          • BooleanConverter<T>
          • BooleanOrConverter
          • BooleanToAutoRowHeightConverter
          • BooleanToFontConverter
          • BooleanToGridRowHeightConverter
          • BooleanToRatioRowHeightConverter
          • BooleanToVisibilityConverter
          • BulletedStringConverter
          • ComparisonConverter
          • EmptyStringConverter
          • EnumMatchToBooleanConverter
          • EnumToBooleanConverter
          • FeedbackCompletedToVisibilityConverter
          • HasSourceToIsEnabledConverter
          • ImageDrawingToXamlConverter
          • ImagePathToImageSourceConverter
          • ImageToBitmapImageConverter
          • InverseBooleanConverter
          • InverseBooleanToVisibilityConverter
          • InverseNullToVisibilityConverter
          • ItemCountToTabNavigationConverter
          • ItemsSourceToCommandConveter
          • LanguageNameToFlagConverter
          • MathMultipleConverter
          • MathOperation
          • MediaColorToBrushColorConverter
          • MenuControlScopeToVisibilityConverter
          • NullableToVisibilityConverter
          • ObservableCollectionCountToVisibilityConverter
          • PercentRangeToColorConverter
          • StringIsNullOrEmptyToBool
          • StringIsNullOrEmptyToVisibility
          • ViewBoxMaxWidthOrHeightConverter
          • VisibilityToBooleanConverter
          • WordCountToStringConverter
          • WpfFormattedText
          • WpfFormattedText.TextPart
        • Sdl.Desktop.Platform.Controls.Errors
          • Severity
          • ValidationResultWithSeverity
        • Sdl.Desktop.Platform.Controls.Summary
          • DetailEntry
          • ISummaryData
          • SummarySection
          • SummaryView
          • SummaryViewModel
        • Sdl.Desktop.Platform.Styles.ImageResources
          • TranslationMemoryIcons
          • UserIcons
        • Sdl.DesktopEditor.BasicControls
          • BasicSegmentEditControl
        • Sdl.DesktopEditor.EditorApi
          • ActiveRowChangedEventArgs
          • AfterEditControlsCreatedEventArgs
          • AfterInitialUpdateEventArgs
          • ChangeNotAllowedException
          • ContentHeightChangedEventArgs
          • ContentNodeIterator
          • ContentRange
          • ContentRange.ReductionAllowedTest
          • CorrespondenceProvider
          • CustomColumnContentChangedEventArgs
          • CustomColumnLocation
          • DocumentContentChangedEventArgs
          • DocumentPropertiesChangedEventArgs
          • EditControlEventArgs
          • EditException
          • EditOperationAbortedEventArgs
          • EditOperationCompletingEventArgs
          • FilePropertiesChangedEventArgs
          • FindType
          • FocusedControlChangedEventArgs
          • FocusedControlChangedEventArgs.FocusChangeType
          • FormattingBuilderVisitor
          • FrameworkDocumentContentChangedEventArgs
          • FrameworkNodeWrapperVisitor
          • IAbstractContainerNode
          • IAbstractContentNode
          • IAbstractEditOperation
          • IAbstractFrameworkDocument
          • IAbstractFrameworkEditControl
          • IAbstractNode
          • IBilingualDocument
          • IBookmarkNode
          • IChangeableBookmarkNode
          • IChangeableCommentContainerNode
          • IChangeableContainerNode
          • IChangeableDocumentContainerNode
          • IChangeableFileContainerNode
          • IChangeableLocationMarkerNode
          • IChangeableLockedContentContainerNode
          • IChangeableMarkerContainerNode
          • IChangeableNode
          • IChangeableParagraphUnitContainerNode
          • IChangeablePlaceholderTagNode
          • IChangeableRevisionMarkerContainerNode
          • IChangeableSegmentContainerNode
          • IChangeableStartEndNode
          • IChangeableTagPairContainerNode
          • IChangeableTextNode
          • IChangeGhostStatusOperation
          • IChangeTextOperation
          • ICollectiveUndoCommand
          • ICommentContainerNode
          • IContentSelection
          • IControl
          • ICustomColumn
          • IDeleteNodeOperation
          • IDocument
          • IDocumentContainerNode
          • IDocumentFragment
          • IEditControl
          • IEditOperationVisitor
          • IFileContainerNode
          • IFind
          • IFindProperties
          • IFrameworkDocument
          • IFrameworkEditControl
          • IInsertNodeOperation
          • IInteractiveCustomColumn
          • ILayoutSynchronizer
          • ILocationMarkerNode
          • ILockedContentContainerNode
          • IMarkupDataNode
          • INode
          • INodeFactory
          • INodeVisitor
          • InteractiveEventFlags
          • InvalidEditOperationException
          • IOtherMarkerContainerNode
          • IParagraphUnitContainerNode
          • IPlaceholderNode
          • IPlaceholderTagNode
          • IRevisionMarkerContainerNode
          • IRowInfo
          • ISegmentContainerNode
          • ISegmentDocument
          • ISegmentEditControl
          • ISideBySideEditor
          • IStartEndNode
          • ISynchronizableCell
          • ISynchronizableLayout
          • ITagPainter
          • ITagPaintingProperties
          • ITagPairContainerNode
          • ITextIterator
          • ITextMark
          • ITextMarkPainter
          • ITextNode
          • ITreeNode<NodeType, ContainerType>
          • IUndoBuffer
          • IUndoCommand
          • MarkupDataNodeFinder
          • MarkupDisplayMode
          • MouseEnteringNodeEventArgs
          • MouseLeavingNodeEventArgs
          • MouseOverTextMarksChangedEventArgs
          • Move
          • NodeIterator
          • OverwriteModeChangedEventArgs
          • ParagraphUnitPropertiesChangedEventArgs
          • PersistentScrollInfoChangedEventArgs
          • Position
          • RowChangedEventArgs
          • RowsChangedEventArgs
          • SegmentPropertiesChangedEventArgs
          • SelectionChangedEventArgs
          • Shading
          • SourceEditingModeEndedEventArgs
          • SourceEditingModeStartedEventArgs
          • TagDisplayMode
          • TextMarkLayer
          • UndoBufferContentChangedEventArgs
          • VScrollEventArgs
        • Sdl.DesktopEditor.EditorApi.Extensions
          • EditorApiExtensions
        • Sdl.DesktopEditor.EditorApi.Implementation
          • AbstractCollectiveUndoCommand
          • AbstractCustomColumn
          • AbstractMarkPainter
          • AbstractMarkPainter.MarkLocation
          • AbstractOperationConsolidator
          • AbstractRowSelectionColumn
          • AbstractTextIterator
          • BackgroundColourPainter
          • BracketPainter
          • ChangeGhostStatusConsolidator
          • ChangeGhostStatusOperation
          • ChangeTextConsolidator
          • ChangeTextOperation
          • CopyFragmentVisitor
          • DeleteNodeOperation
          • DeleteOperationConsolidator
          • DocumentStructureInfoColumn
          • EditControlDisplaySettings
          • EditControlFontSizeSettings
          • EditOperationConsolidatorVisitor
          • FindResultPainter
          • HorizontalLinePainter
          • InsertNodeOperation
          • InsertOperationConsolidator
          • IRowEventSource
          • MarkupDataNodeIterator
          • PlainTextExtractionVisitor
          • PlainTextMapper
          • ProjectEditorSettings
          • RemoveFormattingVisitor
          • RowNumberColumn
          • RowSizeAccessor
          • SegmentIdColumn
          • SquigglyLinePainter
          • SquigglyLinePainter.SquiggleShape
          • TagPaintingProperties
          • TermRecognitionBoldPainter
          • TextMark
          • TextOnlyFragmentVisitor
        • Sdl.LanguageCloud.IdentityApi
          • ILanguageCloudIdentityApi
          • LanguageCloudCredentialInfo
          • LanguageCloudIdentityApi
          • LoginData
        • Sdl.TellMe.ProviderApi
          • AbstractTellMeAction
          • ISearchDataProvider
          • ISearchSpecification
          • ITellMeAction
          • ITellMeControl
          • ITellMePluginLoader
          • ITellMeProvider
          • TellMeProviderAttribute
          • TellMeSearchProviderAttribute
        • Sdl.TranslationStudioAutomation.IntegrationApi
          • AbstractContentSelection
          • AutomationSegmentPairExtension
          • CancelDocumentEventArgs
          • ContentSelectionInfo
          • CurrentProjectCancelEventArgs
          • Document
          • DocumentContentEventArgs
          • DocumentErrorEventArgs
          • DocumentEventArgs
          • DocumentFilterEventArgs
          • DocumentSelection
          • EditingMode
          • EditorController
          • FilesController
          • FocusedDocumentContent
          • IStudioDocument
          • ProjectsController
          • ReportsViewController
          • SdlTradosStudio
          • SourceSelection
          • StudioAutomationIntegrationAPIModule
          • TargetSelection
          • TranslationMemoriesViewController
          • WelcomeViewController
        • Sdl.TranslationStudioAutomation.IntegrationApi.Actions
          • AddProjectAction
          • CloseAllDocumentsAction
          • CloseDocumentAction
          • CloseProjectAction
          • CreateReturnPackageFromProjectAction
          • LanguageCloudAction
          • NewProjectAction
          • OpenDocumentAction
          • OpenPackageAction
          • OpenProjectAction
          • SaveAllDocumentsAction
          • SaveDocumentAction
          • SaveDocumentAsAction
          • SaveDocumentSourceAsAction
          • SaveDocumentTargetAsAction
        • Sdl.TranslationStudioAutomation.IntegrationApi.AutoSuggest
          • AbstractAutoSuggestProvider
          • AbstractAutoSuggestResult
          • AbstractEditingContext
          • AutoSuggestSettings
          • AutoSuggestTextResult
        • Sdl.TranslationStudioAutomation.IntegrationApi.DisplayFilters
          • DisplayFilterAdapter
          • DisplayFilterRowInfo
          • IDisplayFilter
          • IDisplayFilterRowInfo
        • Sdl.TranslationStudioAutomation.IntegrationApi.Editor.ConcordanceSearch
          • ConcordanceSearchController
          • ConcordanceSearchResults
          • ConcordanceSearchType
          • IConcordanceSearchController
        • Sdl.TranslationStudioAutomation.IntegrationApi.Editor.TranslationResults
          • ITranslationResultsController
          • TranslationResults
          • TranslationResultsController
        • Sdl.TranslationStudioAutomation.IntegrationApi.Events
          • AddFileDescriptorExceptionNotificationEvent
          • ChangeSourceContentSettingsEvent
          • CommentsChangedEvent
          • CommentsChangedEvent.CommentEventType
          • CommentsChangedEvent.CommentScope
          • CreateReturnPackageEvent
          • OpenNewProjectWizardEvent
          • OpenProjectForSelectedLanguageEvent
          • OpenProjectPackageEvent
          • ProjectWizardData
          • RefreshProjectsEvent
          • SegmentsMergedEvent
          • SegmentSplitEvent
        • Sdl.TranslationStudioAutomation.IntegrationApi.Extensions
          • AutoSuggestProviderAttribute
          • ExternalPackageConvertorExtensionAttribute
          • ISegmentExtensions
        • Sdl.TranslationStudioAutomation.IntegrationApi.Internal
          • SdlTradosStudioApplication
        • Sdl.TranslationStudioAutomation.IntegrationApi.Packaging
          • ConvertExternalPackageEventArgs
          • ExternalPackageConversionInfo
          • IConversionContext
          • IExternalPackageConverter
          • MessageLevel
          • PackageConversionResult
          • PackageConverterMessageEventArgs
          • PackagingConstants
        • Sdl.TranslationStudioAutomation.IntegrationApi.Presentation
          • EditorReviewLayoutConfiguration
          • EditorSignoffLayoutConfiguration
        • Sdl.TranslationStudioAutomation.IntegrationApi.Presentation.DefaultLocations
          • TranslationStudioDefaultContextMenus
          • TranslationStudioDefaultContextMenus.EditorDocumentContextMenuLocation
          • TranslationStudioDefaultContextMenus.EditorDocumentSpellcheckContextMenuLocation
          • TranslationStudioDefaultContextMenus.FilesContextMenuLocation
          • TranslationStudioDefaultContextMenus.ProjectsContextMenuLocation
          • TranslationStudioDefaultRibbonGroups
          • TranslationStudioDefaultRibbonTabs
          • TranslationStudioDefaultRibbonTabs.EditorAdvancedRibbonTabLocation
          • TranslationStudioDefaultRibbonTabs.EditorReviewRibbonTabLocation
          • TranslationStudioDefaultRibbonTabs.HomeRibbonTabLocation
          • TranslationStudioDefaultViews
          • TranslationStudioDefaultViews.TradosStudioViewsLocation
        • Sdl.TranslationStudioAutomation.Licensing
          • LicenseChecker
          • LicenseManager
          • StudioEdition
          • StudioFeature
        • Sdl.Versioning
          • Company
          • IStudioVersionService
          • StudioVersion
          • StudioVersionService
          • VersionedPaths
          • Versions
    • Verification
      • Overview
      • How to Create a Native Verifier
      • How to Create a Bilingual Verifier
      • How to Create a Global Verifier
        • Create a New Project
        • The Resources File
        • Implement the User Interface
        • Retrieve the Settings Values
        • Implement the UI Controller Class
        • Implement the Verification Logic
        • Enhance the Verifier
      • How to Create a Custom Message Control
        • Introduction to Custom Message Controls
        • Create a Custom Message Control
        • Add suggestion to a Custom Message Control
        • Edit Segment and Apply Changes to Document
      • API Reference
        • Sdl.Verification.Api
          • GlobalVerifierAttribute
          • GlobalVerifierSettingsPageAttribute
          • IGlobalVerifier
          • IHelpTopic
          • ILanguageDirectionVerifier
          • IMessageControlContainer
          • IMessageControlPlugIn
          • ISegmentChangedAware
          • ISerializeVerifierProfile
          • ISuggestionProvider
          • ITermVerifierContext
          • ITermVerifierSettingsContext
          • ITermVerifierSettingsContextAware
          • IVerificationCustomMessageData
          • LanguageDirectionVerifierAttribute
          • MessageControlPlugInAttribute
          • SerializeProfileVerifierAttribute
          • Suggestion
          • TermPicklistField
          • WrongSettingsFileException
    • Batch Tasks
      • Overview
      • Developing a sample batch task
        • What our sample batch task should do
        • Setting up the Visual Studio project
        • Adding a Settings UI to our Batch Task
        • Processing Files and Application Logic
        • Rendering the Task Report
      • API Reference
        • Sdl.ProjectAutomation.AutomaticTasks
          • AbstractFileContentProcessingAutomaticTask
          • AbstractFileLevelAutomaticTask
          • AutomaticTaskAttribute
          • AutomaticTaskFileType
          • AutomaticTaskSupportedFileTypeAttribute
          • CancelHelper
          • LanguageDirection
          • MessageLevel
          • ProjectFileExtension
          • RequiresSettingsAttribute
          • TaskProgressEventArgs
          • WordCounter
    • Terminology Provider
      • Overview
      • Developing a Sample Terminology Provider
        • What our Sample Terminology Provider should do
        • Setting up the Visual Studio project
        • Selecting the Glossary File
        • Setting the Source and Target Language
        • Setting the Glossary Fields
        • Searching Terms
        • Displaying Entry Content
        • Adding Terms
      • API Reference
        • Sdl.Terminology.TerminologyProvider.Core
          • Definition
          • DefinitionLanguage
          • DescriptiveField
          • Entry
          • EntryEventArgs
          • EntryField
          • EntryLanguage
          • EntryTerm
          • EntryTransaction
          • FieldLevel
          • FieldType
          • FilterDefinition
          • GenericCredentials
          • IConnectionAwareTerminologyProvider
          • ILanguage
          • IMultipleTerminologyProvider
          • ITermbaseMetrics
          • ITerminologyExport
          • ITerminologyImport
          • ITerminologyMarkupProvider
          • ITerminologyProvider
          • ITerminologyProviderCredentialStore
          • ITerminologyProviderFactory
          • ITerminologyProviderManager
          • ITerminologyProviderReadOnly
          • ITerminologyProviderViewerWinFormsUI
          • ITerminologyProviderWinFormsUI
          • ITerminologyProviderWinFormsUIWithCreate
          • ITerminologyProviderWinFormsUIWithEdit
          • MarkupPosition
          • SearchMarkupResult
          • SearchMarkupResultWithTermbaseName
          • SearchMode
          • SearchResult
          • SearchResultWithTermbaseName
          • TerminologyExportType
          • TerminologyImportType
          • TerminologyProviderCredential
          • TerminologyProviderCredentialStore
          • TerminologyProviderDisplayInfo
          • TerminologyProviderFactoryAttribute
          • TerminologyProviderManager
          • TerminologyProviderStatus
          • TerminologyProviderType
          • TerminologyProviderViewerWinFormsUIAttribute
          • TerminologyProviderWinFormsUIAttribute
          • TerminologyUserCredentials
          • TerminologyUserManagerTokenType
          • TransactionType
        • Sdl.Terminology.TerminologyProvider.Core.Exceptions
          • ConnectionException
          • InvalidCredentialsException
          • MissingTerminologyProviderException
          • SearchParameterMissingException
          • TermbaseImportException
          • TermbaseInitializationException
          • UnsupportedExportFileFormatException
          • UnsupportedImportFileFormatException
    • Release Notes
      • Release Notes for Trados Studio 2022
      • Release Notes for Trados Studio 2022 SR1
      • Release Notes for Trados Studio 2022 SR2

    Class DocumentStructureInfoColumn

    Custom editor column showing context information for paragraph units.

    Inheritance
    System.Object
    AbstractCustomColumn
    DocumentStructureInfoColumn
    Implements
    IInteractiveCustomColumn
    ICustomColumn
    Inherited Members
    AbstractCustomColumn.CalculateTextSize(Graphics, String, Font)
    AbstractCustomColumn.CalculateTextSize(Graphics, String, Font, Int32)
    AbstractCustomColumn.GetFont()
    AbstractCustomColumn.DrawDefaultBackground(Graphics, Rectangle, IRowInfo)
    AbstractCustomColumn.DrawBorders(Graphics, Rectangle, Pen, Pen, Pen, Pen)
    AbstractCustomColumn.DrawTopBorder(Graphics, Rectangle, Pen)
    AbstractCustomColumn.DrawRightBorder(Graphics, Rectangle, Pen)
    AbstractCustomColumn.DrawBottomBorder(Graphics, Rectangle, Pen)
    AbstractCustomColumn.DrawLeftBorder(Graphics, Rectangle, Pen)
    AbstractCustomColumn.BeginDraw()
    AbstractCustomColumn.SetRowSizeAccessor(RowSizeAccessor)
    AbstractCustomColumn.PrepareRegisterRows()
    AbstractCustomColumn.RegisterRow(IRowInfo)
    AbstractCustomColumn.TextFormat
    AbstractCustomColumn.EditControl
    AbstractCustomColumn.Width
    AbstractCustomColumn.IsComplex
    System.Object.ToString()
    System.Object.Equals(System.Object)
    System.Object.Equals(System.Object, System.Object)
    System.Object.ReferenceEquals(System.Object, System.Object)
    System.Object.GetHashCode()
    System.Object.GetType()
    System.Object.MemberwiseClone()
    Namespace: Sdl.DesktopEditor.EditorApi.Implementation
    Assembly: Sdl.DesktopEditor.EditorApi.dll
    Syntax
    public class DocumentStructureInfoColumn : AbstractCustomColumn, IInteractiveCustomColumn, ICustomColumn
    Remarks

    Contexts are clickable, and the mouse cursor changes to a hand when the user moves the mouse over a cell that has context. Clicking in the column shows extended context information to the user.

    The column shows the context code and uses a background color defined for the most significant context. If several contexts are available a + is appended to the context code to indicate this fact to the user.

    The column also shows a tooltip with the descriptive name of the main context when the user hovers the mouse over a cell with context.

    Cell boundaries are drawn as for paragraphs, i.e. top and bottom borders are only drawn for the first and last row of a paragraph, respectively.

    Constructors

    DocumentStructureInfoColumn()

    Default constructor.

    Declaration
    public DocumentStructureInfoColumn()

    Properties

    EventFlags

    Implementation handles all left mouse click events plus mouse entering and leaving a cell.

    Declaration
    public virtual InteractiveEventFlags EventFlags { get; }
    Property Value
    Type Description
    InteractiveEventFlags

    Methods

    CalculateCellContentHeight(Graphics, IRowInfo)

    Returns the height of the text to be displayed for this row.

    Declaration
    public override int CalculateCellContentHeight(Graphics g, IRowInfo row)
    Parameters
    Type Name Description
    System.Drawing.Graphics g
    IRowInfo row
    Returns
    Type Description
    System.Int32
    Overrides
    AbstractCustomColumn.CalculateCellContentHeight(Graphics, IRowInfo)

    DrawCell(Graphics, IRowInfo, Rectangle, Pen, Pen, Pen, Pen)

    Draw the content of the cell, based on context information associated with the row.

    Declaration
    public override void DrawCell(Graphics g, IRowInfo row, Rectangle cellBounds, Pen leftBorderPen, Pen rightBorderPen, Pen topBorderPen, Pen bottomBorderPen)
    Parameters
    Type Name Description
    System.Drawing.Graphics g
    IRowInfo row
    System.Drawing.Rectangle cellBounds
    System.Drawing.Pen leftBorderPen
    System.Drawing.Pen rightBorderPen
    System.Drawing.Pen topBorderPen
    System.Drawing.Pen bottomBorderPen
    Overrides
    AbstractCustomColumn.DrawCell(Graphics, IRowInfo, Rectangle, Pen, Pen, Pen, Pen)
    Remarks

    The most significant context is used for background and context code.

    If there is no context for this row the default background and the paragraph boundaries are drawn.

    DrawCellBoundaries(IRowInfo, Graphics, Rectangle, Pen, Pen, Pen, Pen)

    Draw cell borders in a way that ensures paragraph boundaries are intact.

    Declaration
    protected void DrawCellBoundaries(IRowInfo row, Graphics g, Rectangle cellBounds, Pen leftBorderPen, Pen rightBorderPen, Pen topBorderPen, Pen bottomBorderPen)
    Parameters
    Type Name Description
    IRowInfo row
    System.Drawing.Graphics g
    System.Drawing.Rectangle cellBounds
    System.Drawing.Pen leftBorderPen
    System.Drawing.Pen rightBorderPen
    System.Drawing.Pen topBorderPen
    System.Drawing.Pen bottomBorderPen

    GetContext(IRowInfo)

    Helper function to locate the contexts associated with a row.

    Declaration
    protected IContextProperties GetContext(IRowInfo row)
    Parameters
    Type Name Description
    IRowInfo row
    Returns
    Type Description
    IContextProperties

    null if the row does not have a context

    GetContextToolTip(IRowInfo)

    Gets the tooltip to display for the current cell by finding the main context. This can be overridden to return a different tooltip.

    Declaration
    protected virtual string GetContextToolTip(IRowInfo row)
    Parameters
    Type Name Description
    IRowInfo row
    Returns
    Type Description
    System.String

    GetMainContext(IRowInfo)

    The (most significant) context to be shown in the column.

    Declaration
    protected IContextInfo GetMainContext(IRowInfo row)
    Parameters
    Type Name Description
    IRowInfo row
    Returns
    Type Description
    IContextInfo

    GetMainContext(IContextProperties)

    Declaration
    protected IContextInfo GetMainContext(IContextProperties context)
    Parameters
    Type Name Description
    IContextProperties context
    Returns
    Type Description
    IContextInfo

    GetOptimalWidth(Graphics)

    Returns the expected maximum width of the content in this column, by default the size of 2 wide capital letters and a plus sign.

    Declaration
    public override int GetOptimalWidth(Graphics g)
    Parameters
    Type Name Description
    System.Drawing.Graphics g
    Returns
    Type Description
    System.Int32
    Overrides
    AbstractCustomColumn.GetOptimalWidth(Graphics)

    GetText(IRowInfo)

    The text to be shown in the column.

    Declaration
    protected virtual string GetText(IRowInfo row)
    Parameters
    Type Name Description
    IRowInfo row
    Returns
    Type Description
    System.String

    IsFirstParagraphRow(IRowInfo)

    Helper to determine if the row is the first row shown for a paragraph.

    Declaration
    public static bool IsFirstParagraphRow(IRowInfo row)
    Parameters
    Type Name Description
    IRowInfo row
    Returns
    Type Description
    System.Boolean

    IsLastParagraphRow(IRowInfo)

    Helper function to determine if the row is the last row to be shown for a paragraph.

    Declaration
    public static bool IsLastParagraphRow(IRowInfo row)
    Parameters
    Type Name Description
    IRowInfo row
    Returns
    Type Description
    System.Boolean

    OnCellMouseDoubleClick(IRowInfo, Rectangle, MouseEventArgs)

    Handled to avoid this being unintentionally processed by the edit control. The implementation does nothing.

    Declaration
    public virtual void OnCellMouseDoubleClick(IRowInfo row, Rectangle cellBounds, MouseEventArgs e)
    Parameters
    Type Name Description
    IRowInfo row
    System.Drawing.Rectangle cellBounds
    System.Windows.Forms.MouseEventArgs e

    OnCellMouseDown(IRowInfo, Rectangle, MouseEventArgs)

    Handled to avoid this being unintentionally processed by the edit control. The implementation does nothing.

    Declaration
    public virtual void OnCellMouseDown(IRowInfo row, Rectangle cellBounds, MouseEventArgs e)
    Parameters
    Type Name Description
    IRowInfo row
    System.Drawing.Rectangle cellBounds
    System.Windows.Forms.MouseEventArgs e

    OnCellMouseEntering(IRowInfo, Rectangle, IRowInfo, Rectangle)

    When the mouse enters a cell with context information the cursor is set to a hand and the tooltip is activated with the display name for the main context.

    Declaration
    public void OnCellMouseEntering(IRowInfo row, Rectangle cellBounds, IRowInfo leavingRow, Rectangle leavingCellBounds)
    Parameters
    Type Name Description
    IRowInfo row
    System.Drawing.Rectangle cellBounds
    IRowInfo leavingRow
    System.Drawing.Rectangle leavingCellBounds

    OnCellMouseLeaving(IRowInfo, Rectangle, IRowInfo, Rectangle)

    When the mouse leaves a cell the mouse cursor is restored and the tool tip is hidden.

    Declaration
    public void OnCellMouseLeaving(IRowInfo row, Rectangle cellBounds, IRowInfo enteringRow, Rectangle enteringCellBounds)
    Parameters
    Type Name Description
    IRowInfo row
    System.Drawing.Rectangle cellBounds
    IRowInfo enteringRow
    System.Drawing.Rectangle enteringCellBounds

    OnCellMouseMove(IRowInfo, Rectangle, MouseEventArgs)

    Not used.

    Declaration
    public virtual void OnCellMouseMove(IRowInfo row, Rectangle cellBounds, MouseEventArgs e)
    Parameters
    Type Name Description
    IRowInfo row
    System.Drawing.Rectangle cellBounds
    System.Windows.Forms.MouseEventArgs e

    OnCellMouseRightDown(IRowInfo, Rectangle, MouseEventArgs)

    Not used.

    Declaration
    public virtual void OnCellMouseRightDown(IRowInfo row, Rectangle cellBounds, MouseEventArgs e)
    Parameters
    Type Name Description
    IRowInfo row
    System.Drawing.Rectangle cellBounds
    System.Windows.Forms.MouseEventArgs e

    OnCellMouseRightUp(IRowInfo, Rectangle, MouseEventArgs)

    Not used.

    Declaration
    public virtual void OnCellMouseRightUp(IRowInfo row, Rectangle cellBounds, MouseEventArgs e)
    Parameters
    Type Name Description
    IRowInfo row
    System.Drawing.Rectangle cellBounds
    System.Windows.Forms.MouseEventArgs e

    OnCellMouseUp(IRowInfo, Rectangle, MouseEventArgs)

    Performs the "click on" functionality - i.e. show details about the contexts.

    Declaration
    public virtual void OnCellMouseUp(IRowInfo row, Rectangle cellBounds, MouseEventArgs e)
    Parameters
    Type Name Description
    IRowInfo row
    System.Drawing.Rectangle cellBounds
    System.Windows.Forms.MouseEventArgs e

    OnContentChanged(Object, CustomColumnContentChangedEventArgs)

    Fire the ContentChanged event.

    Declaration
    public virtual void OnContentChanged(object sender, CustomColumnContentChangedEventArgs args)
    Parameters
    Type Name Description
    System.Object sender
    CustomColumnContentChangedEventArgs args

    ShowCellToolTip(IRowInfo)

    Displays the tooltip for the cell using GetContextToolTip(IRowInfo).

    Declaration
    protected void ShowCellToolTip(IRowInfo row)
    Parameters
    Type Name Description
    IRowInfo row

    Events

    ContentChanged

    Currently not used by this column.

    Declaration
    public event EventHandler<CustomColumnContentChangedEventArgs> ContentChanged
    Event Type
    Type Description
    System.EventHandler<CustomColumnContentChangedEventArgs>

    Implements

    IInteractiveCustomColumn
    ICustomColumn

    Extension Methods

    WindowsControlUtils.ForWindowFromFrameworkElement(Object, Action<Window>)

    On this page

    • Constructors
      • DocumentStructureInfoColumn()
    • Properties
      • EventFlags
    • Methods
      • CalculateCellContentHeight(Graphics, IRowInfo)
      • DrawCell(Graphics, IRowInfo, Rectangle, Pen, Pen, Pen, Pen)
      • DrawCellBoundaries(IRowInfo, Graphics, Rectangle, Pen, Pen, Pen, Pen)
      • GetContext(IRowInfo)
      • GetContextToolTip(IRowInfo)
      • GetMainContext(IRowInfo)
      • GetMainContext(IContextProperties)
      • GetOptimalWidth(Graphics)
      • GetText(IRowInfo)
      • IsFirstParagraphRow(IRowInfo)
      • IsLastParagraphRow(IRowInfo)
      • OnCellMouseDoubleClick(IRowInfo, Rectangle, MouseEventArgs)
      • OnCellMouseDown(IRowInfo, Rectangle, MouseEventArgs)
      • OnCellMouseEntering(IRowInfo, Rectangle, IRowInfo, Rectangle)
      • OnCellMouseLeaving(IRowInfo, Rectangle, IRowInfo, Rectangle)
      • OnCellMouseMove(IRowInfo, Rectangle, MouseEventArgs)
      • OnCellMouseRightDown(IRowInfo, Rectangle, MouseEventArgs)
      • OnCellMouseRightUp(IRowInfo, Rectangle, MouseEventArgs)
      • OnCellMouseUp(IRowInfo, Rectangle, MouseEventArgs)
      • OnContentChanged(Object, CustomColumnContentChangedEventArgs)
      • ShowCellToolTip(IRowInfo)
    • Events
      • ContentChanged
    • Implements
    • Extension Methods
    Back to top Generated by DocFX