Interface IAbstractInlineTagProperties
Common tag properties specific to inline tags, i.e. tags that can be found inside (translatable) text.
Namespace: Sdl.FileTypeSupport.Framework.NativeApi
Assembly: Sdl.FileTypeSupport.Framework.Core.dll
Syntax
public interface IAbstractInlineTagProperties
Properties
CanHide
Indicates whether the tag is allowed to be hidden during editing operations.
Declaration
bool CanHide { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
Remarks
Hidden tags can easily get deleted by mistake during editing operations.
Always set this to false
for tags that represent important content that the
user should not delete unknowingly.
Typically this is set to true
for elements like tag pairs that represent pure
character formatting, without any other associated functionality - and only if the relevant
Sdl.FileTypeSupport.Framework.Formatting properties have been set for the tag, so that the user
can see what the character formatting actually looks like in the editor without any need to see the tags.
Setting this to true
does not necessarily mean that the tag will always be hidden.
This will be determined by the editor (i.e. the user may change this at runtime through a setting).
This is false
by default for all tag types.
IsSoftBreak
Indicates whether it is valid to break the line in front of this tag during word wrap.
Declaration
bool IsSoftBreak { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
Remarks
May be used by word wrapping algorithms in editors.
This is true
by default for all tag types.
IsWordStop
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.
Declaration
bool IsWordStop { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
Examples
During segmentation, if a tag has IsWordStop false then "hello[tag]world[/tag]" is considered to be one word - "hello[tag]world[/tag]" and if a tag has IsWordStop true then "hello[tag]world[/tag]" is considered to be two words - "hello" and "[tag]world[/tag]".