Back to Devexpress

CaptionHelper Members

expressappframework-devexpress-dot-expressapp-dot-utils-dot-captionhelper-dot-underscore-members.md

latest12.8 KB
Original Source

CaptionHelper Members

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

Constructors

NameDescription
CaptionHelper()Intended for internal use.

Fields

NameDescription
CaptionsLocalizationGroupSpecifies the default name for the Application Model‘s Localization
DefaultLanguageSpecifies the default language display caption (see Localization Basics).
DefaultNullValueTextSpecifies the default value for the Value property of the Application Model‘s Localization
EnableCaptionCache staticSpecifies if XAF caches class and member captions for all locales.
NoneValueThis field is intended for internal use.
NullValueTextNodeNameSpecifies the name of the Application Model‘s Localization
TextsLocalizationGroupSpecifies the default name for the Application Model‘s Localization
UserLanguageSpecifies the user language display caption (see Localization Basics). This is the default value of the Application Model‘s IModelApplication.PreferredLanguage property.

Properties

NameDescription
ApplicationModel staticProvides access to the Application Model.
NullValueText staticSpecifies the localized value of the Localization
RemoveAcceleratorSymbol staticSpecifies whether the CaptionHelper.GetLocalizedText method removes the ampersand character that displays accelerator keys in captions.

Methods

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

Events

NameDescription
CustomizeConvertCompoundName staticOccurs after a call to the CaptionHelper.ConvertCompoundName method. Allows you to manually process a compound name that’s being converted.

See Also

CaptionHelper Class

DevExpress.ExpressApp.Utils Namespace