Class LocExtensions

Inheritance
System.Object
LocExtensions
Namespace: Eco.Shared.Localization
Assembly: Eco.Shared.dll
Syntax
public static class LocExtensions : Object

Methods

AppendLineIfNeeded(StringBuilder)

Declaration
public static void AppendLineIfNeeded(this StringBuilder s)
Parameters
Type Name Description
System.Text.StringBuilder s

AppendLineIfSet(StringBuilder, String)

Declaration
public static void AppendLineIfSet(this StringBuilder sb, string text)
Parameters
Type Name Description
System.Text.StringBuilder sb
System.String text

AppendLineIfSetLoc(StringBuilder, FormattableString)

Declaration
public static void AppendLineIfSetLoc(this StringBuilder sb, FormattableString text)
Parameters
Type Name Description
System.Text.StringBuilder sb
System.FormattableString text

AppendLineIfSetLocStr(StringBuilder, String)

Declaration
public static void AppendLineIfSetLocStr(this StringBuilder sb, string text)
Parameters
Type Name Description
System.Text.StringBuilder sb
System.String text

AppendLineLoc(StringBuilder, FormattableString)

Declaration
public static void AppendLineLoc(this StringBuilder s, FormattableString text)
Parameters
Type Name Description
System.Text.StringBuilder s
System.FormattableString text

AppendLineLocStr(StringBuilder, String)

Declaration
public static void AppendLineLocStr(this StringBuilder s, string text)
Parameters
Type Name Description
System.Text.StringBuilder s
System.String text

AppendLineParenLoc(StringBuilder, FormattableString)

Declaration
public static void AppendLineParenLoc(this StringBuilder s, FormattableString text)
Parameters
Type Name Description
System.Text.StringBuilder s
System.FormattableString text

AppendLoc(StringBuilder, FormattableString)

Declaration
public static void AppendLoc(this StringBuilder s, FormattableString text)
Parameters
Type Name Description
System.Text.StringBuilder s
System.FormattableString text

AppendLocStr(StringBuilder, String)

Declaration
public static void AppendLocStr(this StringBuilder s, string text)
Parameters
Type Name Description
System.Text.StringBuilder s
System.String text

AppendShowMoreLoc(LocStringBuilder, Int32)

Declaration
public static void AppendShowMoreLoc(this LocStringBuilder sb, int addedNum)
Parameters
Type Name Description
LocStringBuilder sb
System.Int32 addedNum

AppendStringWhileRespectingMaxLength(LocStringBuilder, LocString, Int32, Boolean)

Append a LocString respecting length limit.

Declaration
public static void AppendStringWhileRespectingMaxLength(this LocStringBuilder s, LocString append, int maxlength, bool addSpace = false)
Parameters
Type Name Description
LocStringBuilder s
LocString append
System.Int32 maxlength
System.Boolean addSpace
Remarks

Crops first LocString if the length exceeds limit and appends second. Has an option to include space in between.

CropUntilLengthIfNeeded(LocStringBuilder, Int32)

Crops LocStringBuilder to given maxLength.

Declaration
public static void CropUntilLengthIfNeeded(this LocStringBuilder s, int maxLength)
Parameters
Type Name Description
LocStringBuilder s
System.Int32 maxLength
Remarks

If the LocString is shorter than maxLength returns same LocString.

GetEnumLocDisplayName(Enum)

Get only Loc Display name from localized Enum

Declaration
public static LocString GetEnumLocDisplayName(this Enum e)
Parameters
Type Name Description
System.Enum e
Returns
Type Description
LocString

GetLocDescription(Enum)

Declaration
public static LocString GetLocDescription(this Enum e)
Parameters
Type Name Description
System.Enum e
Returns
Type Description
LocString

GetLocDescription(MemberInfo)

Declaration
public static LocString GetLocDescription(this MemberInfo member)
Parameters
Type Name Description
System.Reflection.MemberInfo member
Returns
Type Description
LocString

GetLocDescription(Type)

Declaration
public static LocString GetLocDescription(this Type type)
Parameters
Type Name Description
System.Type type
Returns
Type Description
LocString

GetLocDisplayName(Enum, Boolean, Boolean)

Get FOLDOUT Loc Display name of an Enum value. If that value has LocDisplayNameAttribute then use that instead of the Value's name. If that value has LocDescriptionAttribute then do foldout with the description.

Declaration
public static LocString GetLocDisplayName(this Enum e, bool plural = false, bool foldout = true)
Parameters
Type Name Description
System.Enum e
System.Boolean plural
System.Boolean foldout
Returns
Type Description
LocString

GetLocDisplayName(MemberInfo)

Get a localized display name, using the the defined LocDisplayName attribute, or if that's missing, by localizing the 'remove camel case' of the name.

Declaration
public static LocString GetLocDisplayName(this MemberInfo member)
Parameters
Type Name Description
System.Reflection.MemberInfo member
Returns
Type Description
LocString

GetLocDisplayNameColored(MemberInfo)

Get the display name and query the color of this property from the Color attribute and apply it.

Declaration
public static LocString GetLocDisplayNameColored(this MemberInfo member)
Parameters
Type Name Description
System.Reflection.MemberInfo member
Returns
Type Description
LocString

GetLocEnumName(Type, Object)

Declaration
public static LocString GetLocEnumName(this Type enumType, object entry)
Parameters
Type Name Description
System.Type enumType
System.Object entry
Returns
Type Description
LocString

GetLocEnumName<TEnum>(TEnum)

Declaration
public static LocString GetLocEnumName<TEnum>(this TEnum enumValue)
    where TEnum : Enum
Parameters
Type Name Description
TEnum enumValue
Returns
Type Description
LocString
Type Parameters
Name Description
TEnum

GetName(Enum)

Declaration
public static string GetName(this Enum e)
Parameters
Type Name Description
System.Enum e
Returns
Type Description
System.String

InsertLine(LocStringBuilder, LocString)

Declaration
public static void InsertLine(this LocStringBuilder sb, LocString line)
Parameters
Type Name Description
LocStringBuilder sb
LocString line

InsertLineLoc(LocStringBuilder, FormattableString)

Inserts the line at the beginning of the builder.

Declaration
public static void InsertLineLoc(this LocStringBuilder sb, FormattableString line)
Parameters
Type Name Description
LocStringBuilder sb
System.FormattableString line

Join(LocStringBuilder, String)

Declaration
public static void Join(this LocStringBuilder s, string text)
Parameters
Type Name Description
LocStringBuilder s
System.String text

Join(StringBuilder, String)

Declaration
public static void Join(this StringBuilder s, string text)
Parameters
Type Name Description
System.Text.StringBuilder s
System.String text

JoinIfNeeded(LocStringBuilder, LocString, String)

Declaration
public static void JoinIfNeeded(this LocStringBuilder s, LocString text, string sep = "\n")
Parameters
Type Name Description
LocStringBuilder s
LocString text
System.String sep

JoinIfNeeded(StringBuilder, LocString, String)

Declaration
public static void JoinIfNeeded(this StringBuilder s, LocString text, string sep = "\n")
Parameters
Type Name Description
System.Text.StringBuilder s
LocString text
System.String sep

JoinIfNeededLoc(LocStringBuilder, FormattableString, String)

Declaration
public static void JoinIfNeededLoc(this LocStringBuilder s, FormattableString text, string sep = "\n")
Parameters
Type Name Description
LocStringBuilder s
System.FormattableString text
System.String sep

JoinIfNeededLoc(StringBuilder, FormattableString, String)

Declaration
public static void JoinIfNeededLoc(this StringBuilder s, FormattableString text, string sep = "\n")
Parameters
Type Name Description
System.Text.StringBuilder s
System.FormattableString text
System.String sep

JoinLoc(LocStringBuilder, FormattableString)

Declaration
public static void JoinLoc(this LocStringBuilder s, FormattableString text)
Parameters
Type Name Description
LocStringBuilder s
System.FormattableString text

JoinLoc(StringBuilder, FormattableString)

Declaration
public static void JoinLoc(this StringBuilder s, FormattableString text)
Parameters
Type Name Description
System.Text.StringBuilder s
System.FormattableString text

JoinLocStr(LocStringBuilder, String)

Declaration
public static void JoinLocStr(this LocStringBuilder s, string text)
Parameters
Type Name Description
LocStringBuilder s
System.String text

JoinLocStr(StringBuilder, String)

Declaration
public static void JoinLocStr(this StringBuilder s, string text)
Parameters
Type Name Description
System.Text.StringBuilder s
System.String text

JoinWithSpaceIfNeeded(LocStringBuilder, LocString)

Declaration
public static void JoinWithSpaceIfNeeded(this LocStringBuilder s, LocString text)
Parameters
Type Name Description
LocStringBuilder s
LocString text

JoinWithSpaceIfNeeded(StringBuilder, LocString)

Declaration
public static void JoinWithSpaceIfNeeded(this StringBuilder s, LocString text)
Parameters
Type Name Description
System.Text.StringBuilder s
LocString text

JoinWithSpaceIfNeededLoc(StringBuilder, FormattableString)

Declaration
public static void JoinWithSpaceIfNeededLoc(this StringBuilder s, FormattableString text)
Parameters
Type Name Description
System.Text.StringBuilder s
System.FormattableString text

JoinWithSpaceIfNeededLocStr(StringBuilder, String)

Declaration
public static void JoinWithSpaceIfNeededLocStr(this StringBuilder s, string text)
Parameters
Type Name Description
System.Text.StringBuilder s
System.String text

Loc(StringBuilder)

Declaration
public static LocString Loc(this StringBuilder sb)
Parameters
Type Name Description
System.Text.StringBuilder sb
Returns
Type Description
LocString

ToStringLoc(StringBuilder)

Declaration
public static LocString ToStringLoc(this StringBuilder s)
Parameters
Type Name Description
System.Text.StringBuilder s
Returns
Type Description
LocString