Click or drag to resize
IStartTagProperties Interface
Information on an inline paired start tag.

Namespace: Sdl.FileTypeSupport.Framework.NativeApi
Assembly: Sdl.FileTypeSupport.Framework.Core (in Sdl.FileTypeSupport.Framework.Core.dll) Version: 1.0.0.0 (1.0.2343.0)
Syntax
public interface IStartTagProperties : IAbstractTagProperties, 
	IAbstractBasicTagProperties, IMetaDataContainer, ICloneable, IAbstractInlineTagProperties

The IStartTagProperties type exposes the following members.

Methods
  NameDescription
Public methodAddSubSegment
Adds localizable content as a sub-segment for this tag.
(Inherited from IAbstractTagProperties.)
Public methodAddSubSegments
Adds a collection of localizable sub-segments for this tag.
(Inherited from IAbstractTagProperties.)
Public methodClearMetaData
Removes all key/value pairs from the meta data collection.
(Inherited from IMetaDataContainer.)
Public methodClearSubSegments
Removes all localizable content for this tag.
(Inherited from IAbstractTagProperties.)
Public methodClone
Creates a new object that is a copy of the current instance.
(Inherited from ICloneable.)
Public methodGetMetaData
Returns the metadata value associated with the specified key, or null if no such key exists in the collection.
(Inherited from IMetaDataContainer.)
Public methodMetaDataContainsKey
True if a metadata value with the specified key exists
(Inherited from IMetaDataContainer.)
Public methodRemoveMetaData
Removes the metadata key/value pair with the specified key from the collection. No changes are made if the collection does not contain such a key.
(Inherited from IMetaDataContainer.)
Public methodRemoveSubSegment
Removes localizable content for this tag.
(Inherited from IAbstractTagProperties.)
Public methodSetMetaData

Sets the value of the specified metadata key.

If the key already exists in the collection, its value gets overwritten.

(Inherited from IMetaDataContainer.)
Public methodSortSubSegments
Sorts the localizable sub-segments by start offset.
(Inherited from IAbstractTagProperties.)
Top
Properties
  NameDescription
Public propertyCanHide
Indicates whether the tag is allowed to be hidden during editing operations.
(Inherited from IAbstractInlineTagProperties.)
Public propertyDisplayText
A shortened version of a tag that can be used in translation editors that implement full and abbreviated tag views. Often the GI without attributes.
(Inherited from IAbstractBasicTagProperties.)
Public propertyFormatting
Semi-WYSIWYG formatting associated with this tag pair.
Public propertyHasLocalizableContent
True if LocalizableContent is not null, and has at least one sub-segment.
(Inherited from IAbstractTagProperties.)
Public propertyHasMetaData
True if there is any metadata in the container
(Inherited from IMetaDataContainer.)
Public propertyIsSoftBreak
Indicates whether it is valid to break the line in front of this tag during word wrap.
(Inherited from IAbstractInlineTagProperties.)
Public propertyCode exampleIsWordStop
Determines whether the tag is considered to be a new word during segmentation. It also affects the way that the caret moves when using word movement keyboard actions such as CTRL+LEFT ARROW and CTRL+RIGHT ARROW in editors.
(Inherited from IAbstractInlineTagProperties.)
Public propertyLocalizableContent
Translatable content inside the tag, in the order in which it appears. An example of such content may be localizable attribute values in HTML or XML.
(Inherited from IAbstractTagProperties.)
Public propertyMetaData
Enumerator for the metadata key/value pairs.
(Inherited from IMetaDataContainer.)
Public propertyMetaDataCount
The number of meta data key/value pairs in the container
(Inherited from IMetaDataContainer.)
Public propertySegmentationHint
Indicates how the tag pair should be treated during segmentation.
Public propertyTagContent
This property usually holds the whole tag with delimiters and all attributes during the entire forward and backward conversion process.
(Inherited from IAbstractBasicTagProperties.)
Public propertyTagId
Identifier for a tag.

Tags originating from the native parser typically have unique ids.

In the bilingual content model, corresponding tags between source and target can be identified by their ids.

If a tag is cloned, it will have the same id as its clone. It may therefore happen during conversion from bilingual to native format that multiple tags have the same id. In such cases the native content handler may assume that the tags have been cloned for localization purposes.

(Inherited from IAbstractTagProperties.)
Top
Remarks

By default, start and end tag properties have IsWordStop set to false, as paired tags normally represent formatting or similar information, which should not affect the word boundaries in the text.

See Also
Community
Edit
Be the first to Edit the community content of this topic.
Comments