User Class

Represents information about the user, such as name and account picture.

Inheritance Hierarchy

SystemObject
CauldronUser

Namespace: Cauldron
Assembly: Cauldron.Win32.UserInformation (in Cauldron.Win32.UserInformation.dll) Version: 3.2.0.1 (3.2.0.1)

Syntax

Copy

public sealed class User : IEquatable<User>

The User type exposes the following members.

Properties

	Name	Description
	AccountPicture	Gets the account picture for the user.
	DisplayName	Gets the display name for the user account.
	DomainName	Gets the domain name for the user.
	EmailAddress	Gets the user's email address.
	FirstName	Gets the user's first name.
	HomeDirectory	Gets the user's home directory.
	IsLocalAccount	Gets a value that indicates if the user account is local or domain. Returns true if the account is a local account, otherwise false
	IsLockedOut	Gets a value that indicates if the user is locked out or not
	LastName	Gets the user's last name.
	PrincipalName	Gets the principal name for the user. This name is the User Principal Name (typically the user's address, although this is not always true.)
	TelephoneNumber	Gets the telephone number of the user
	UserName	Gets the user name of the user.
	WTSClientName	Gets a the user's Windows Terminal Service's client name. The value will fallback to MachineName if there is no client name available.

Top

Methods

	Name	Description
	Equals(Object)	Determines whether the specified object is equal to the current object (Overrides ObjectEquals(Object).)
	Equals(User)	Determines whether the specified object is equal to the current object
	GetHashCode	Returns the hash code for this object (Overrides ObjectGetHashCode.)
	ToString	Returns domainname and username (Overrides ObjectToString.)

Top

Extension Methods

	Name	Description
	As(Type)	Overloaded. Converts a type using the implicit or explicit operators. If both fails it will try to convert the value with ChangeType(Object, Type). (Defined by ExtensionsConvertions.)
	As(Type, Type)	Overloaded. Converts a type using the implicit or explicit operators. If both fails it will try to convert the value with ChangeType(Object, Type). (Defined by ExtensionsConvertions.)
	AsT	Overloaded. Performs a cast between compatible reference types. If a convertion is not possible then null is returned. As a last resort it will use ChangeType(Object, Type). Tries to use the implicit and explicit operators if exists when convertion with 'as' returns null. (Defined by ExtensionsConvertions.)
	CreateTypeT	Creates a new Type that implements the properties of an interface defined by T and copies all value of anon to the new object. (Defined by ExtensionsInterception.)
	GetPropertyNonPublicValueT	Searches for the specified property, using the specified binding constraints and returns its value. Default BindingFlags are Instance and NonPublic (Defined by ExtensionsReflection.)
	GetPropertyValue(String, BindingFlags)	Overloaded. Searches for the specified property, using the specified binding constraints and returns its value. (Defined by ExtensionsReflection.)
	GetPropertyValueT(String)	Overloaded. Searches for the specified property, using the specified binding constraints and returns its value. Default BindingFlags are Instance and Public (Defined by ExtensionsReflection.)
	GetPropertyValueT(String, BindingFlags)	Overloaded. Searches for the specified property, using the specified binding constraints and returns its value. (Defined by ExtensionsReflection.)
	MapToT	Maps all properties and fields of an instance to another instance. The Clone() method is used to copy an instance if exist. Mapping fails on jagged and multidimensional array. Classes without parameterless constructor will stay null. (Defined by ExtensionsCloning.)
	ToLong	Tries to convert a Object to an Int64. Returns MinValue if target cannot be parsed. (Defined by ExtensionsConvertions.)
	ToStringEx(String)	Overloaded. Converts the value of this instance to its equivalent string representation, using the specified format. The following custom formatter are already added: ByteSizeFormatter, MetricUnitFormatter (Defined by Extensions.)
	ToStringEx(String, CultureInfo)	Overloaded. Converts the value of this instance to its equivalent string representation, using the specified format. The following custom formatter are already added: ByteSizeFormatter, MetricUnitFormatter (Defined by Extensions.)
	TryDispose	Tries to performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. This will dispose an object if it implements the IDisposable interface. (Defined by Extensions.)

Top

Reference

Cauldron Namespace