ValidationHelper Class

Global class providing Validation methods.

Inheritance Hierarchy

System.Object
  CMS.Helpers.ValidationHelper

Namespace: CMS.Helpers
Assembly: CMS.Helpers (in CMS.Helpers.dll) Version: 8.2.23

Syntax

public class ValidationHelper

The ValidationHelper type exposes the following members.

Constructors

	Name	Description
Public method	ValidationHelper

Methods

	Name	Description
Public method Static member	AreEmails(Object)	Returns true if the object representation matches the Email list (email addresses separated by semicolon).
Public method Static member	AreEmails(Object, String)	Returns true if the object representation matches the Email list separated by specified character (default separator is semicolon).
Public method Static member	Base64Decode	Method used to obtain original text formatted to UTF-8 and encoded in base64
Public method Static member	GetBinary	Returns the byte[] representation of an object or default value if not.
Public method Static member	GetBoolean	Returns the boolean representation of an object or default value if not.
Public method Static member	GetCodeName(Object, Int32)	Gets the code name created from the given string.
Public method Static member	GetCodeName(String, String, String)	Gets the code name created from the given display name.
Public method Static member	GetCodeName(Object, String, Int32, Boolean, Boolean, String, Boolean)	Gets the code name created from the given string.
Public method Static member	GetColor	Returns the color representation of a query parameter or default value if parameter is not a valid color.
Public method Static member	GetDate(Object, DateTime)	Returns the DateTime representation of an object or default value if not.
Public method Static member	GetDate(Object, DateTime, CultureInfo)	Returns the DateTime representation of an object or default value if not.
Public method Static member	GetDateSystem	Returns the DateTime representation of an object (using English representation of date and time) or default value if not.
Public method Static member	GetDateTime(Object, DateTime, CultureInfo)	Returns the DateTime representation of an object or default value if not.
Public method Static member	GetDateTime(Object, DateTime, String)	Returns the DateTime representation of an object or default value if not.
Public method Static member	GetDateTimeSystem	Returns the DateTime representation of an object (using English representation of date and time) or default value if not.
Public method Static member	GetDecimal(Object, Decimal)	Converts the given object to a decimal value
Public method Static member	GetDecimal(Object, Decimal, CultureInfo)	Converts the given object to a decimal value
Public method Static member	GetDecimalSystem	Converts the given object to a decimal value
Public method Static member	GetDefaultHashStringSalt	Gets the default hash string salt
Public method Static member	GetDouble(Object, Double, CultureInfo)	Returns the double representation of an object or default value if not.
Public method Static member	GetDouble(Object, Double, String)	Returns the double representation of an object or default value if not.
Public method Static member	GetDoubleSystem	Returns the double representation of an object (using English representation of floating point numbers) or default value if not.
Public method Static member	GetFloat	Returns the double representation of an object or default value if not.
Public method Static member	GetGuid	Returns the GUID representation of an object or default value if not.
Public method Static member	GetHashString(String, HashSettings)	Gets the SHA2 hash for the given value (salt unique to certain user session and database is added).
Public method Static member	GetHashString(String, Boolean, String, String)	Obsolete. Gets the SHA2 hash for the given value (salt unique to certain user session and database is added).
Public method Static member	GetHResult	Converts HResult (ErrorCode) from exception to format comparable with error codes in hex format.
Public method Static member	GetIdentifier(Object)	Gets the identifier created from the given name
Public method Static member	GetIdentifier(Object, String)	Gets the identifier created from the given name
Public method Static member	GetInteger	Returns the integer representation of an object or default value if not.
Public method Static member	GetIntegers	Returns array of integer representations of supplied values or default value when not an int.
Public method Static member	GetLanguage	Gets the language created from the given string.
Public method Static member	GetLong	Returns the long representation of an object or default value if not.
Public method Static member	GetNullableBoolean	Returns the boolean representation of an object or default value if a conversion doesn't exist.
Public method Static member	GetSafeFileName	Get safe file name in which forbidden characters are replaced with specified replacement
Public method Static member	GetSafeInteger	Returns the integer representation of an object or default value if not. Consumes all exceptions.
Public method Static member	GetSafeRoleName	Gets safe version of rolename.
Public method Static member	GetSafeUserName	Gets safe version of username.
Public method Static member	GetSafeXML	Removes forbidden characters from given xml string.
Public method Static member	GetString(Object, String, CultureInfo)	Returns the string representation of an object or default value if not.
Public method Static member	GetString(Object, String, String)	Returns the string representation of an object or default value if not.
Public method Static member	GetString(Object, String, String, String)	Returns the string representation of an object or default value if not.
Public method Static member	GetStringFromHash	Gets string from byte array.
Public method Static member	GetTimeSpan(Object, TimeSpan)	Converts the given object to a decimal value
Public method Static member	GetTimeSpan(Object, TimeSpan, CultureInfo)	Converts the given object to a decimal value
Public method Static member	GetTimeSpanSystem	Converts the given object to a decimal value
Public method Static member	GetValue<ReturnType>(Object)	Converts the value to specified type.
Public method Static member	GetValue<T>(Object, T)	Converts the value to specified type. If the value is null, default value is used.
Public method Static member	IsAllowedXMLCharacter	Returns true if the character is within range of allowed characters.
Public method Static member	IsBoolean	Returns true if the object representation matches the Boolean type.
Public method Static member	IsCodeName	Returns true if the object representation matches the Code name.
Public method Static member	IsColor	Returns true if the object representation matches the hexa color code expression or value is an existing string representation of color.
Public method Static member	IsDateTime	Returns true if the object representation matches the date time format.
Public method Static member	IsDecimal	Returns true if the object representation matches the Decimal type.
Public method Static member	IsDouble	Returns true if the object representation matches the Double type.
Public method Static member	IsDoubleSystem	Returns true if the object representation matches the Double type in English culture.
Public method Static member	IsEmail	Returns true if the object representation matches the Email.
Public method Static member	IsFileName	Returns true if the object representation matches the file name.
Public method Static member	IsFolderName	Returns true if the object representation matches the folder name.
Public method Static member	IsFullName	Returns true if the object representation matches full name form ([namespace].[classname].[identifier]).
Public method Static member	IsGuid	Returns true if the object representation matches the Guid type.
Public method Static member	IsIdentifier	Returns true if the object representation matches the IdentifierRegExp.
Public method Static member	IsInRange(Double, Double, Double)	Returns true if value is higher than or equal to minimum and lesser than or equal to maximum.
Public method Static member	IsInRange(Int32, Int32, Int32)	Returns true if value is higher than or equal to minimum and lesser than or equal to maximum.
Public method Static member	IsInteger	Returns true if the object representation matches the Integer type.
Public method Static member	IsIntervalValid	Returns true if fromDate precedes toDate.
Public method Static member	IsLong	Returns true if the object representation matches the Long type.
Public method Static member	IsPositiveNumber	Returns true if the object representation matches the positive number.
Public method Static member	IsRegularExp	Returns true if the object representation matches given regular expression.
Public method Static member	IsSpecialFileName	Returns true if the file name is restricted.
Public method Static member	IsSpecialFolderName	Returns true if the folder name is restricted.
Public method Static member	IsTimeSpan	Returns true if the object representation matches the TimeSpan type.
Public method Static member	IsType	Returns true if value is of type.
Public method Static member	IsURL	Returns true if the given URL is valid.
Public method Static member	IsUserName	Returns true if the object representation matches the User name.
Public method Static member	IsUsPhoneNumber	Returns true if the object representation matches the U.S. Phone number.
Public method Static member	IsValidClientID	Returns true if the object representation matches the criteria for valid client id value.
Public method Static member	LoadBoolean	Attempts to load the given new value as a bool to the result. Returns true if the conversion of the new value was successful, if not, returns false and keeps the value the same.
Public method Static member	LoadDateTime	Attempts to load the given new value as a DateTime to the result. Returns true if the conversion of the new value was successful, if not, returns false and keeps the value the same.
Public method Static member	LoadDateTimeSystem	Attempts to load the given new value as a DateTime to the result (it uses en-us culture). Returns true if the conversion of the new value was successful, if not, returns false and keeps the value the same.
Public method Static member	LoadDouble	Attempts to load the given new value as a double to the result. Returns true if the conversion of the new value was successful, if not, returns false and keeps the value the same.
Public method Static member	LoadDoubleSystem	Attempts to load the given new value as a double to the result (it uses en-us culture). Returns true if the conversion of the new value was successful, if not, returns false and keeps the value the same.
Public method Static member	LoadGuid	Attempts to load the given new value as a Guid to the result. Returns true if the conversion of the new value was successful, if not, returns false and keeps the value the same.
Public method Static member	LoadInteger	Attempts to load the given new value as an integer to the result. Returns true if the conversion of the new value was successful, if not, returns false and keeps the value the same.
Public method Static member	LoadLong	Attempts to load the given new value as a long to the result. Returns true if the conversion of the new value was successful, if not, returns false and keeps the value the same.
Public method Static member	LoadString	Attempts to load the given new value as a string to the result. Returns true if the conversion of the new value was successful, if not, returns false and keeps the value the same.
Public method Static member	ValidateHash(String, String, HashSettings)	Validates the hash for the given value.
Public method Static member	ValidateHash(String, String, Boolean, Boolean, String, String)	Obsolete. Validates the hash for the given value.
Public method Static member	ValidateHashes	Validates the hashes for the given values.

Extension Methods

	Name	Description
Public Extension Method	AsValue	Converts object to a query value which can be used as a query parameter (Defined by QueryExtensions.)
Public Extension Method	GetAPIString	Gets the string by the specified resource key (Defined by CoreExtensions.)
Public Extension Method	GetString	Gets the string by the specified resource key (Defined by CoreExtensions.)
Public Extension Method	ToBoolean	Returns the boolean representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToDateTime	Returns the DateTime representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToDouble	Returns the double representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToGuid	Returns the Guid representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToInteger	Returns the integer representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToString	Returns the string representation of an object or default value if not. (Defined by CoreExtensions.)

Fields

	Name	Description
Public field Static member	APP_SETTINGS_HASH_STRING_SALT	App setting key for hash string salt.

Properties

	Name	Description
Public property Static member	ClientIDRexExp	Gets or sets the regular expression for client id validation.
Public property Static member	CodenameRegExp	Codename regular expression.
Public property Static member	ColorRegExp	Hexa color code regular expression.
Public property Static member	CustomEmailRegExpString	Custom email regular expression string from web.config for email validation.
Public property Static member	CustomUsernameRegExpString	Custom user name regular expression string from web.config for user name validation.
Public property Static member	EmailRegExp	Gets the regular expression used to validate e-mail addresses.
Public property Static member	FileNameForbiddenCharRegExp	Regular expression to match forbidden characters in file name.
Public property Static member	FolderRegExp	Folder regular expression.
Public property Static member	GuidRegExp	GUID regular expression.
Public property Static member	HashStringSalt	Returns salt used for hashing string in GetHashString() method.
Public property Static member	IdentifierRegExp	Identifier regular expression.
Public property Static member	IntRegExp	Integer regular expression.
Public property Static member	LongRegExp	Long regular expression.
Public property Static member	UnicodeCodenameRegExp	Codename regular expression with support of Unicode letters.
Public property Static member	URLRegExp	URL regular expression.
Public property Static member	UsernameRegExp	Username regular expression.
Public property Static member	UseSafeRoleName	Indicates whether to use safe or normal role names.
Public property Static member	UseSafeUserName	Indicates whether to use safe or normal user names.
Public property Static member	UsPhoneNumberRegExp	U.S. Phone number regular expression.