.NET Framework 4.5.2+
.NET Framework 4.5.2+
.NET Standard 2.0+
.NET Core 3.0+

CaptionHelper Members

Exposes static methods used to localize display captions in an XAF application.

Constructors

Name Description
CaptionHelper() Intended for internal use.

Fields

Name Description
CaptionsLocalizationGroup Specifies the default name for the Application Model's Localization | Captions node.
DefaultLanguage Specifies the default language display caption (see Localization Basics).
DefaultNullValueText Specifies the default value for the Value property of the Application Model's Localization | Texts | NullValueText node.
NoneValue This field is intended for internal use.
NullValueTextNodeName Specifies the name of the Application Model's Localization | Texts | NullValueText node.
TextsLocalizationGroup Specifies the default name for the Application Model's Localization | Texts node.
UserLanguage Specifies the user language display caption (see Localization Basics). This is the default value of the Application Model's IModelApplication.PreferredLanguage property.

Properties

Name Description
ApplicationModel static Provides access to the Application Model.
NullValueText static Specifies the localized value of the Localization | Texts | NullValueText node's Value property.
RemoveAcceleratorSymbol static Specifies whether the ampersand character used to represent accelerator keys in captions is removed by the CaptionHelper.GetLocalizedText method.

Methods

Name Description
ConvertCompoundName(String) static Converts a compound name so that the words forming the name are separated by white spaces.
ConvertCompoundName(String, CompoundNameConvertStyle) static Converts a compound name according to the specified CompoundNameConvertStyle mode.
Equals(Object) Determines whether the specified object is equal to the current object.
(Inherited from Object)
Equals(Object, Object) static Determines whether the specified object instances are considered equal.
(Inherited from Object)
FindGroupNode(IModelApplication, String) static Provides access to the LocalizationGroup node corresponding to a specific group path.
FindGroupNode(String) static Provides access to the LocalizationGroup node corresponding to a specific group path.
GetActionCaption(String) static Returns the display caption corresponding to an Action.
GetAspectByCultureInfo(CultureInfo) static Returns the language identifier for a specific culture.
GetBoolText(Boolean) static Returns the default display caption corresponding to a Boolean value.
GetClassCaption(String) static Returns the display caption corresponding to a business class.
GetCultureInfoByAspect(String) static Returns the culture which corresponds to a specific language identifier.
GetDisplayText(Object) static Returns the value of the specified object's default member.
GetFullMemberCaption(ITypeInfo, String) static This method is intended for internal use.
GetHashCode() Serves as the default hash function.
(Inherited from Object)
GetLastMemberPartCaption(Type, String) static This method is intended for internal use.
GetLocalizedItems(String) static Returns the names and values of all the localization items for a particular LocalizationGroup.
GetLocalizedText(String, String) static Returns the value of a specified LocalizationItem.
GetLocalizedText(String, String, Object[]) static Returns the value of a specified LocalizationItem.
GetLocalizedText(String, String, String) static Returns the value of a specified LocalizationItem.
GetMemberCaption(IMemberInfo) static Returns the display caption corresponding to a business class' property.
GetMemberCaption(ITypeInfo, String) static Returns the display caption corresponding to a business class' property.
GetMemberCaption(Type, String) static Returns the display caption corresponding to a business class' property.
GetModelLocalizationGroup(String) static Gets a node that contains a group of localizable items by its path.
GetParentAspect(String) static Returns the neutral culture for a given specific culture.
GetType() Gets the Type of the current instance.
(Inherited from Object)
IsAncestorAspect(String, String) static This method is intended for internal use.
MemberwiseClone() protected Creates a shallow copy of the current Object.
(Inherited from Object)
ReferenceEquals(Object, Object) static Determines whether the specified Object instances are the same instance.
(Inherited from Object)
RemoveModelApplicationIfNeed(IModelApplication) static This method is intended for internal use.
SetLocalizedText(IModelLocalizationGroup, IList<String>, IList<String>) static Performs a batch update of the IModelLocalizationItem.Value property values for the LocalizationItem child nodes of a particular LocalizationGroup node.
SetLocalizedText(String, IDictionary<String, String>) static This SetLocalizedText method overload is intended for internal use.
SetLocalizedText(String, IList<String>, IList<String>) static This SetLocalizedText method overload is intended for internal use.
SetLocalizedText(String, String, String) static This SetLocalizedText method overload is intended for internal use.
Setup(IModelApplication) static Initializes the CaptionHelper.
ToString() Returns a string that represents the current object.
(Inherited from Object)

Events

Name Description
CustomizeConvertCompoundName static Occurs after a call to the CaptionHelper.ConvertCompoundName method. Allows you to manually process a compound name that's being converted.
See Also