This is a base class from which readonly business classes can be derived. More...

Inheritance diagram for Csla.ReadOnlyBase< T >:

Public Member Functions
override string	ToString ()
	Returns a text representation of this object by returning the GetIdValue value in text form.
virtual bool	CanReadProperty (IPropertyInfo property)
	Returns true if the user is allowed to read the calling property.
bool	CanReadProperty (IPropertyInfo property, bool throwOnFalse)
	Returns true if the user is allowed to read the calling property.
bool	CanReadProperty (string propertyName)
virtual bool	CanExecuteMethod (IMemberInfo method)
	Returns true if the user is allowed to execute the specified method.
bool	CanExecuteMethod (IMemberInfo method, bool throwOnFalse)
	Returns true if the user is allowed to execute the specified method.
virtual bool	CanExecuteMethod (string methodName)
	Returns true if the user is allowed to execute the specified method.
virtual object	GetClone ()
	Creates a clone of the object.
T	Clone ()
	Creates a clone of the object.
async Task	WaitForIdle ()
	Await this method to ensure business object is not busy running async rules.
Task	WaitForIdle (TimeSpan timeout)
	Await this method to ensure business object is not busy running async rules.
Task	WaitForIdle (CancellationToken ct)
	Waits for the object to become idle.

Protected Member Functions
virtual ? object	GetIdValue ()
	Override this method to return a unique identifying value for this object.
	ReadOnlyBase ()
	Creates an instance of the type.
virtual void	Initialize ()
	Override this method to set up event handlers so user code in a partial class can respond to events raised by generated code.
virtual void	AddBusinessRules ()
	Override this method to add per-type authorization rules for your type's properties.
virtual void	DataPortal_OnDataPortalInvoke (DataPortalEventArgs e)
	Called by the server-side DataPortal prior to calling the requested DataPortal_xyz method.
virtual void	DataPortal_OnDataPortalInvokeComplete (DataPortalEventArgs e)
	Called by the server-side DataPortal after calling the requested DataPortal_xyz method.
virtual void	DataPortal_OnDataPortalException (DataPortalEventArgs e, Exception ex)
	Called by the server-side DataPortal if an exception occurs during data access.
virtual void	Child_OnDataPortalInvoke (DataPortalEventArgs e)
	Called by the server-side DataPortal prior to calling the requested DataPortal_XYZ method.
virtual void	Child_OnDataPortalInvokeComplete (DataPortalEventArgs e)
	Called by the server-side DataPortal after calling the requested DataPortal_XYZ method.
virtual void	Child_OnDataPortalException (DataPortalEventArgs e, Exception ex)
	Called by the server-side DataPortal if an exception occurs during data access.
virtual void	Deserialized ()
	Invoked after the object has been deserialized to allow derived classes to perform custom post-deserialization processing.
P?	GetProperty< P > (string propertyName, P? field, P? defaultValue)
	Gets a property's value, first checking authorization.
P?	GetProperty< P > (string propertyName, P? field, P? defaultValue, NoAccessBehavior noAccess)
	Gets a property's value, first checking authorization.
P?	GetProperty<[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)] P > (PropertyInfo< P > propertyInfo, P? field)
	Gets a property's value, first checking authorization.
P?	GetProperty<[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)] P > (PropertyInfo< P > propertyInfo, P? field, P? defaultValue, NoAccessBehavior noAccess)
	Gets a property's value, first checking authorization.
P?	LazyGetProperty<[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)] P > (PropertyInfo< P > property, Func< P > valueGenerator)
	Lazily initializes a property and returns the resulting value.
bool	PropertyIsLoading (IPropertyInfo propertyInfo)
	Gets a value indicating whether a lazy loaded property is currently being retrieved.
P?	LazyGetPropertyAsync<[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)] P > (PropertyInfo< P > property, Task< P > factory)
	Lazily initializes a property and returns the resulting value.
P?	GetPropertyConvert<[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)] F, [DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)] P > (PropertyInfo< F > propertyInfo, F? field)
	Gets a property's value as a specified type, first checking authorization.
P?	GetPropertyConvert<[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)] F, [DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)] P > (PropertyInfo< F > propertyInfo, F? field, NoAccessBehavior noAccess)
	Gets a property's value as a specified type, first checking authorization.
P?	GetProperty<[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)] P > (PropertyInfo< P > propertyInfo)
	Gets a property's managed field value, first checking authorization.
P?	GetPropertyConvert<[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)] F, [DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)] P > (PropertyInfo< F > propertyInfo)
	Gets a property's value from the list of managed field values, first checking authorization, and converting the value to an appropriate type.
P?	GetPropertyConvert<[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)] F, [DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)] P > (PropertyInfo< F > propertyInfo, NoAccessBehavior noAccess)
	Gets a property's value from the list of managed field values, first checking authorization, and converting the value to an appropriate type.
P?	GetProperty<[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)] P > (PropertyInfo< P > propertyInfo, NoAccessBehavior noAccess)
	Gets a property's value as a specified type, first checking authorization.
object?	GetProperty (IPropertyInfo propertyInfo)
	Gets a property's value as a specified type.
P?	ReadPropertyConvert<[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)] F, [DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)] P > (PropertyInfo< F > propertyInfo)
	Gets a property's value from the list of managed field values, converting the value to an appropriate type.
P?	ReadProperty<[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)] P > (PropertyInfo< P > propertyInfo)
	Gets a property's value as a specified type.
virtual ? object	ReadProperty (IPropertyInfo propertyInfo)
	Gets a property's value as a specified type.
P?	LazyReadProperty<[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)] P > (PropertyInfo< P > property, Func< P > valueGenerator)
	Gets a property's value as a specified type.
P?	LazyReadPropertyAsync<[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)] P > (PropertyInfo< P > property, Task< P > factory)
	Gets a property's value as a specified type.
void	LoadPropertyConvert<[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)] P, [DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)] F > (PropertyInfo< P > propertyInfo, F? newValue)
	Loads a property's managed field with the supplied value calling PropertyHasChanged if the value does change.
void	LoadProperty<[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)] P > (PropertyInfo< P > propertyInfo, P? newValue)
	Loads a property's managed field with the supplied value calling PropertyHasChanged if the value does change.
virtual void	LoadProperty (IPropertyInfo propertyInfo, object? newValue)
	Loads a property's managed field with the supplied value calling PropertyHasChanged if the value does change.
void	LoadPropertyAsync<[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)] R > (PropertyInfo< R > property, Task< R > factory)
	Load a property from an async method.
void	MarkBusy ()
	Marks the object as being busy (it is running an async operation).
void	MarkIdle ()
	Marks the object as being not busy (it is not running an async operation).
void	OnBusyChanged (string propertyName, bool busy)
	Raises the BusyChanged event.
virtual void	OnBusyChanged (BusyChangedEventArgs args)
	Raises the BusyChanged event.
override void	OnGetChildren (SerializationInfo info, MobileFormatter formatter)
	Override this method to insert your child object references into the MobileFormatter serialization stream.
override void	OnSetChildren (SerializationInfo info, MobileFormatter formatter)
	Override this method to retrieve your child object references from the MobileFormatter serialization stream.
virtual void	OnUnhandledAsyncException (Core.ErrorEventArgs error)
	Raises the UnhandledAsyncException event.
void	OnUnhandledAsyncException (object originalSender, Exception error)
	Raises the UnhandledAsyncException event.
Protected Member Functions inherited from Csla.Core.BindableBase
	BindableBase ()
	Creates an instance of the type.
virtual bool	ShouldHandlerSerialize (PropertyChangedEventHandler value)
	Override this method to change the default logic for determining if the event handler should be serialized.
virtual void	OnPropertyChanged (string propertyName)
	Call this method to raise the PropertyChanged event for a specific property.
virtual void	OnMetaPropertyChanged (string propertyName)
virtual void	OnPropertyChanged (IPropertyInfo propertyInfo)
	Call this method to raise the PropertyChanged event for a specific property.
virtual void	OnIsDirtyChanged ()
	Call this method to raise the PropertyChanged event for all object properties.
virtual void	OnUnknownPropertyChanged ()
	Call this method to raise the PropertyChanged event for all object properties.
virtual void	OnIsDirtyChanging ()
	Call this method to raise the PropertyChanging event for all object properties.
virtual void	OnUnknownPropertyChanging ()
	Call this method to raise the PropertyChanging event for all object properties.
virtual void	OnPropertyChanging (string propertyName)
	Call this method to raise the PropertyChanging event for a specific property.
virtual void	OnPropertyChanging (IPropertyInfo propertyInfo)
	Call this method to raise the PropertyChanging event for a specific property.
virtual bool	ShouldHandlerSerialize (PropertyChangingEventHandler value)
	Override this method to change the default logic for determining if the event handler should be serialized.
Protected Member Functions inherited from Csla.Core.MobileObject
virtual void	OnGetState (SerializationInfo info, StateMode mode)
	Override this method to insert your field values into the MobileFormatter serialization stream.
virtual void	OnSetState (SerializationInfo info, StateMode mode)
	Override this method to retrieve your field values from the MobileFormatter serialization stream.
virtual void	OnGetMetastate (BinaryWriter writer)
	Override this method to write field values directly to a binary stream for metastate serialization.
virtual void	OnSetMetastate (BinaryReader reader)
	Override this method to read field values directly from a binary stream for metastate deserialization.

Static Protected Member Functions
static PropertyInfo< P >	RegisterProperty<[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)] P > ([DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)] Type objectType, PropertyInfo< P > info)
	Indicates that the specified property belongs to the type.
static PropertyInfo< P >	RegisterProperty<[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)] P > (PropertyInfo< P > info)
	Indicates that the specified property belongs to the business object type.
static PropertyInfo< P >	RegisterProperty<[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)] P > (string propertyName)
	Indicates that the specified property belongs to the business object type.
static PropertyInfo< P >	RegisterProperty<[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)] P > (Expression< Func< T, object > > propertyLambdaExpression)
	Indicates that the specified property belongs to the business object type.
static PropertyInfo< P >	RegisterProperty<[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)] P > (string propertyName, string? friendlyName)
	Indicates that the specified property belongs to the business object type.
static PropertyInfo< P >	RegisterProperty<[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)] P > (Expression< Func< T, object > > propertyLambdaExpression, string? friendlyName)
	Indicates that the specified property belongs to the business object type.
static PropertyInfo< P >	RegisterProperty<[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)] P > (string propertyName, string? friendlyName, P? defaultValue)
	Indicates that the specified property belongs to the business object type.
static PropertyInfo< P >	RegisterProperty<[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)] P > (Expression< Func< T, object > > propertyLambdaExpression, string? friendlyName, P? defaultValue)
	Indicates that the specified property belongs to the business object type.
static PropertyInfo< P >	RegisterProperty<[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)] P > (string propertyName, RelationshipTypes relationship)
	Indicates that the specified property belongs to the business object type.
static PropertyInfo< P >	RegisterProperty<[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)] P > (Expression< Func< T, object > > propertyLambdaExpression, RelationshipTypes relationship)
	Indicates that the specified property belongs to the business object type.
static PropertyInfo< P >	RegisterProperty<[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)] P > (string propertyName, string? friendlyName, P? defaultValue, RelationshipTypes relationship)
	Indicates that the specified property belongs to the business object type.
static PropertyInfo< P >	RegisterProperty<[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)] P > (Expression< Func< T, object > > propertyLambdaExpression, string? friendlyName, P? defaultValue, RelationshipTypes relationship)
	Indicates that the specified property belongs to the business object type.
static IMemberInfo	RegisterMethod (Type objectType, IMemberInfo info)
	Indicates that the specified method belongs to the type.
static MethodInfo	RegisterMethod (Type objectType, string methodName)
	Indicates that the specified method belongs to the type.
static MethodInfo	RegisterMethod (string methodName)
	Registers a method for use in Authorization.
static MethodInfo	RegisterMethod (Expression< Action< T > > methodLambdaExpression)
	Registers the method.

Properties
ApplicationContext	ApplicationContext `[get, set]`
	Gets or sets the current ApplicationContext object.
virtual bool	IsCanReadPropertyAuthorizationCheckDisabled = false `[get]`
	Gets or sets if CanReadProperty(IPropertyInfo) performs an authorization check or not. `true` means read is always allowed. `false` means an authorization check is always performed.
BusinessRules	BusinessRules `[get]`
	Provides access to the broken rules functionality.
FieldDataManager	FieldManager `[get]`
	Gets the PropertyManager object for this business object.
virtual bool	IsBusy `[get]`
	Gets a value indicating whether this object or any of its child objects are running an async operation.
virtual bool	IsSelfBusy `[get]`
	Gets a value indicating whether this object is running an async operation.

Events
BusyChangedEventHandler?	BusyChanged `[add, remove]`
	Event raised when the IsBusy property value has changed.
EventHandler< Core.ErrorEventArgs >?	UnhandledAsyncException `[add, remove]`
	Event raised when an exception occurs on a background thread during an asynchronous operation.
Events inherited from Csla.Core.BindableBase
PropertyChangedEventHandler?	PropertyChanged `[add, remove]`
	Implements a serialization-safe PropertyChanged event.
PropertyChangingEventHandler?	PropertyChanging `[add, remove]`
	Implements a serialization-safe PropertyChanging event.

Detailed Description

This is a base class from which readonly business classes can be derived.

This base class only supports data retrieve, not updating or deleting. Any business classes derived from this base class should only implement readonly properties.

Template Parameters

T	Type of the business object.

Type Constraints

T

:

ReadOnlyBase<T>

Member Function Documentation

◆ AddBusinessRules()

virtual void Csla.ReadOnlyBase< T >.AddBusinessRules ( )

inlineprotectedvirtual

Override this method to add per-type authorization rules for your type's properties.

AddSharedAuthorizationRules is automatically called by CSLA .NET when your object should associate per-type authorization roles with its properties.

◆ CanExecuteMethod() [1/3]

virtual bool Csla.ReadOnlyBase< T >.CanExecuteMethod ( IMemberInfo method )

inlinevirtual

Returns true if the user is allowed to execute the specified method.

Parameters

method Method to execute.

Returns: true if execute is allowed.

Exceptions

ArgumentNullException method is null.

◆ CanExecuteMethod() [2/3]

bool Csla.ReadOnlyBase< T >.CanExecuteMethod	(	IMemberInfo	method,
		bool	throwOnFalse )

inline

Returns true if the user is allowed to execute the specified method.

Returns: true if execute is allowed.

Parameters

method	Method to execute.
throwOnFalse	Indicates whether a negative result should cause an exception.

Exceptions

ArgumentNullException method is null.

◆ CanExecuteMethod() [3/3]

virtual bool Csla.ReadOnlyBase< T >.CanExecuteMethod ( string methodName )

inlinevirtual

Returns true if the user is allowed to execute the specified method.

Parameters

methodName Name of the method to execute.

Returns: true if execute is allowed.

Exceptions

ArgumentException methodName is null, string.Empty or only consists of white spaces.

◆ CanReadProperty() [1/3]

virtual bool Csla.ReadOnlyBase< T >.CanReadProperty ( IPropertyInfo property )

inlinevirtual

Returns true if the user is allowed to read the calling property.

Parameters

property Property to check.

Exceptions

ArgumentNullException property is null.

◆ CanReadProperty() [2/3]

bool Csla.ReadOnlyBase< T >.CanReadProperty	(	IPropertyInfo	property,
		bool	throwOnFalse )

inline

Returns true if the user is allowed to read the calling property.

Returns: true if read is allowed.

Parameters

property	Property to read.
throwOnFalse	Indicates whether a negative result should cause an exception.

Exceptions

ArgumentNullException property is null.

◆ CanReadProperty() [3/3]

bool Csla.ReadOnlyBase< T >.CanReadProperty ( string propertyName )

inline

◆ Child_OnDataPortalException()

virtual void Csla.ReadOnlyBase< T >.Child_OnDataPortalException	(	DataPortalEventArgs	e,
		Exception	ex )

inlineprotectedvirtual

Called by the server-side DataPortal if an exception occurs during data access.

Parameters

e	The DataPortalContext object passed to the DataPortal.
ex	The Exception thrown during data access.

◆ Child_OnDataPortalInvoke()

virtual void Csla.ReadOnlyBase< T >.Child_OnDataPortalInvoke ( DataPortalEventArgs e )

inlineprotectedvirtual

Called by the server-side DataPortal prior to calling the requested DataPortal_XYZ method.

Parameters

e	The DataPortalContext object passed to the DataPortal.

◆ Child_OnDataPortalInvokeComplete()

virtual void Csla.ReadOnlyBase< T >.Child_OnDataPortalInvokeComplete ( DataPortalEventArgs e )

inlineprotectedvirtual

Called by the server-side DataPortal after calling the requested DataPortal_XYZ method.

Parameters

e	The DataPortalContext object passed to the DataPortal.

◆ Clone()

T Csla.ReadOnlyBase< T >.Clone ( )

inline

Creates a clone of the object.

Returns: A new object containing the exact data of the original object.

◆ DataPortal_OnDataPortalException()

virtual void Csla.ReadOnlyBase< T >.DataPortal_OnDataPortalException	(	DataPortalEventArgs	e,
		Exception	ex )

inlineprotectedvirtual

Called by the server-side DataPortal if an exception occurs during data access.

Parameters

e	The DataPortalContext object passed to the DataPortal.
ex	The Exception thrown during data access.

◆ DataPortal_OnDataPortalInvoke()

virtual void Csla.ReadOnlyBase< T >.DataPortal_OnDataPortalInvoke ( DataPortalEventArgs e )

inlineprotectedvirtual

Called by the server-side DataPortal prior to calling the requested DataPortal_xyz method.

Parameters

e	The DataPortalContext object passed to the DataPortal.

◆ DataPortal_OnDataPortalInvokeComplete()

virtual void Csla.ReadOnlyBase< T >.DataPortal_OnDataPortalInvokeComplete ( DataPortalEventArgs e )

inlineprotectedvirtual

Called by the server-side DataPortal after calling the requested DataPortal_xyz method.

Parameters

e	The DataPortalContext object passed to the DataPortal.

◆ Deserialized()

virtual void Csla.ReadOnlyBase< T >.Deserialized ( )

inlineprotectedvirtual

Invoked after the object has been deserialized to allow derived classes to perform custom post-deserialization processing.

Override this method in a derived class to implement actions that should occur immediately after deserialization, such as initializing transient fields or validating object state. This method is called automatically during the deserialization process.

◆ GetClone()

virtual object Csla.ReadOnlyBase< T >.GetClone ( )

inlinevirtual

Creates a clone of the object.

Returns: A new object containing the exact data of the original object.

◆ GetIdValue()

virtual ? object Csla.ReadOnlyBase< T >.GetIdValue ( )

inlineprotectedvirtual

Override this method to return a unique identifying value for this object.

◆ GetProperty()

object? Csla.ReadOnlyBase< T >.GetProperty ( IPropertyInfo propertyInfo )

inlineprotected

Gets a property's value as a specified type.

Parameters

propertyInfo PropertyInfo object containing property metadata.

If the user is not authorized to read the property value, the defaultValue value is returned as a result.

Exceptions

ArgumentNullException propertyInfo is null.

◆ GetProperty() [1/2]

P? Csla.ReadOnlyBase< T >.GetProperty< P >	(	string	propertyName,
		P?	field,
		P?	defaultValue )

inlineprotected

Gets a property's value, first checking authorization.

Template Parameters

P	Type of the property.

Parameters

field	The backing field for the property.
propertyName	The name of the property.
defaultValue	Value to be returned if the user is not authorized to read the property.

If the user is not authorized to read the property value, the defaultValue value is returned as a result.

Exceptions

ArgumentNullException propertyName is null.

◆ GetProperty() [2/2]

P? Csla.ReadOnlyBase< T >.GetProperty< P >	(	string	propertyName,
		P?	field,
		P?	defaultValue,
		NoAccessBehavior	noAccess )

inlineprotected

Gets a property's value, first checking authorization.

Template Parameters

P	Type of the property.

Parameters

field	The backing field for the property.
propertyName	The name of the property.
defaultValue	Value to be returned if the user is not authorized to read the property.
noAccess	True if an exception should be thrown when the user is not authorized to read this property.

Exceptions

ArgumentNullException propertyName is null.

◆ GetProperty<[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)] P >() [1/4]

P? Csla.ReadOnlyBase< T >.GetProperty<[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)] P > ( PropertyInfo propertyInfo )

inlineprotected

Gets a property's managed field value, first checking authorization.

Template Parameters

P	Type of the property.

Parameters

propertyInfo PropertyInfo object containing property metadata.

If the user is not authorized to read the property value, the defaultValue value is returned as a result.

Exceptions

ArgumentNullException propertyInfo is null.

◆ GetProperty<[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)] P >() [2/4]

P? Csla.ReadOnlyBase< T >.GetProperty<[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)] P >	(	PropertyInfo< P >	propertyInfo,
		NoAccessBehavior	noAccess )

inlineprotected

Gets a property's value as a specified type, first checking authorization.

Template Parameters

P	Type of the property.

Parameters

propertyInfo	PropertyInfo object containing property metadata.
noAccess	True if an exception should be thrown when the user is not authorized to read this property.

If the user is not authorized to read the property value, the defaultValue value is returned as a result.

Exceptions

ArgumentNullException propertyInfo is null.

◆ GetProperty<[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)] P >() [3/4]

P? Csla.ReadOnlyBase< T >.GetProperty<[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)] P >	(	PropertyInfo< P >	propertyInfo,
		P?	field )

inlineprotected

Gets a property's value, first checking authorization.

Template Parameters

P	Type of the property.

Parameters

field	The backing field for the property.
propertyInfo	PropertyInfo object containing property metadata.

If the user is not authorized to read the property value, the defaultValue value is returned as a result.

Exceptions

ArgumentNullException propertyInfo is null.

◆ GetProperty<[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)] P >() [4/4]

P? Csla.ReadOnlyBase< T >.GetProperty<[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)] P >	(	PropertyInfo< P >	propertyInfo,
		P?	field,
		P?	defaultValue,
		NoAccessBehavior	noAccess )

inlineprotected

Gets a property's value, first checking authorization.

Template Parameters

P	Type of the property.

Parameters

field	The backing field for the property.
propertyInfo	PropertyInfo object containing property metadata.
defaultValue	Value to be returned if the user is not authorized to read the property.
noAccess	True if an exception should be thrown when the user is not authorized to read this property.

Exceptions

ArgumentNullException propertyInfo is null.

◆ GetPropertyConvert<[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)] F, [DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)] P >() [1/4]

P? Csla.ReadOnlyBase< T >.GetPropertyConvert<[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)] F,[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)] P > ( PropertyInfo< F > propertyInfo )

inlineprotected

Gets a property's value from the list of managed field values, first checking authorization, and converting the value to an appropriate type.

Template Parameters

F	Type of the field.
P	Type of the property.

Parameters

propertyInfo PropertyInfo object containing property metadata.

If the user is not authorized to read the property value, the defaultValue value is returned as a result.

Exceptions

ArgumentNullException propertyInfo is null.

◆ GetPropertyConvert<[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)] F, [DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)] P >() [2/4]

P? Csla.ReadOnlyBase< T >.GetPropertyConvert<[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)] F,[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)] P >	(	PropertyInfo< F >	propertyInfo,
		F?	field )

inlineprotected

Gets a property's value as a specified type, first checking authorization.

Template Parameters

F	Type of the field.
P	Type of the property.

Parameters

field	The backing field for the property.
propertyInfo	PropertyInfo object containing property metadata.

If the user is not authorized to read the property value, the defaultValue value is returned as a result.

Exceptions

ArgumentNullException propertyInfo is null.

◆ GetPropertyConvert<[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)] F, [DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)] P >() [3/4]

P? Csla.ReadOnlyBase< T >.GetPropertyConvert<[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)] F,[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)] P >	(	PropertyInfo< F >	propertyInfo,
		F?	field,
		NoAccessBehavior	noAccess )

inlineprotected

Gets a property's value as a specified type, first checking authorization.

Template Parameters

F	Type of the field.
P	Type of the property.

Parameters

field	The backing field for the property.
propertyInfo	PropertyInfo object containing property metadata.
noAccess	True if an exception should be thrown when the user is not authorized to read this property.

If the user is not authorized to read the property value, the defaultValue value is returned as a result.

Exceptions

ArgumentNullException propertyInfo is null.

◆ GetPropertyConvert<[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)] F, [DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)] P >() [4/4]

P? Csla.ReadOnlyBase< T >.GetPropertyConvert<[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)] F,[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)] P >	(	PropertyInfo< F >	propertyInfo,
		NoAccessBehavior	noAccess )

inlineprotected

Gets a property's value from the list of managed field values, first checking authorization, and converting the value to an appropriate type.

Template Parameters

F	Type of the field.
P	Type of the property.

Parameters

propertyInfo	PropertyInfo object containing property metadata.
noAccess	True if an exception should be thrown when the user is not authorized to read this property.

If the user is not authorized to read the property value, the defaultValue value is returned as a result.

Exceptions

ArgumentNullException propertyInfo is null.

◆ Initialize()

virtual void Csla.ReadOnlyBase< T >.Initialize ( )

inlineprotectedvirtual

Override this method to set up event handlers so user code in a partial class can respond to events raised by generated code.

◆ LazyGetProperty<[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)] P >()

P? Csla.ReadOnlyBase< T >.LazyGetProperty<[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)] P >	(	PropertyInfo< P >	property,
		Func< P >	valueGenerator )

inlineprotected

Lazily initializes a property and returns the resulting value.

Template Parameters

P	Type of the property.

Parameters

property	PropertyInfo object containing property metadata.
valueGenerator	Method returning the new value.

If the user is not authorized to read the property value, the defaultValue value is returned as a result.

Exceptions

ArgumentNullException property or valueGenerator is null.

◆ LazyGetPropertyAsync<[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)] P >()

P? Csla.ReadOnlyBase< T >.LazyGetPropertyAsync<[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)] P >	(	PropertyInfo< P >	property,
		Task< P >	factory )

inlineprotected

Lazily initializes a property and returns the resulting value.

Template Parameters

P	Type of the property.

Parameters

property	PropertyInfo object containing property metadata.
factory	Async method returning the new value.

Note that the first value returned is almost certainly the defaultValue because the value is initialized asynchronously. The real value is provided later along with a PropertyChanged event to indicate the value has changed.

If the user is not authorized to read the property value, the defaultValue value is returned as a result.

Exceptions

ArgumentNullException property or property is null.

◆ LazyReadProperty<[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)] P >()

P? Csla.ReadOnlyBase< T >.LazyReadProperty<[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)] P >	(	PropertyInfo< P >	property,
		Func< P >	valueGenerator )

inlineprotected

Gets a property's value as a specified type.

Template Parameters

P	Type of the property.

Parameters

property	PropertyInfo object containing property metadata.
valueGenerator	Method returning the new value.

Exceptions

ArgumentNullException property or valueGenerator is null.

◆ LazyReadPropertyAsync<[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)] P >()

P? Csla.ReadOnlyBase< T >.LazyReadPropertyAsync<[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)] P >	(	PropertyInfo< P >	property,
		Task< P >	factory )

inlineprotected

Gets a property's value as a specified type.

Template Parameters

P	Type of the property.

Parameters

property	PropertyInfo object containing property metadata.
factory	Async method returning the new value.

Exceptions

ArgumentNullException property or factory is null.

◆ LoadProperty()

virtual void Csla.ReadOnlyBase< T >.LoadProperty	(	IPropertyInfo	propertyInfo,
		object?	newValue )

inlineprotectedvirtual

Loads a property's managed field with the supplied value calling PropertyHasChanged if the value does change.

Parameters

propertyInfo	PropertyInfo object containing property metadata.
newValue	The new value for the property.

No authorization checks occur when this method is called, and no PropertyChanging or PropertyChanged events are raised. Loading values does not cause validation rules to be invoked.

Exceptions

ArgumentNullException propertyInfo is null.

◆ LoadProperty<[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)] P >()

void Csla.ReadOnlyBase< T >.LoadProperty<[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)] P >	(	PropertyInfo< P >	propertyInfo,
		P?	newValue )

inlineprotected

Loads a property's managed field with the supplied value calling PropertyHasChanged if the value does change.

Template Parameters

P	Type of the property.

Parameters

propertyInfo	PropertyInfo object containing property metadata.
newValue	The new value for the property.

No authorization checks occur when this method is called, and no PropertyChanging or PropertyChanged events are raised. Loading values does not cause validation rules to be invoked.

Exceptions

ArgumentNullException propertyInfo is null.

◆ LoadPropertyAsync<[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)] R >()

void Csla.ReadOnlyBase< T >.LoadPropertyAsync<[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)] R >	(	PropertyInfo< R >	property,
		Task< R >	factory )

inlineprotected

Load a property from an async method.

Template Parameters

R

Parameters

property
factory

Exceptions

ArgumentNullException property or factory is null.

◆ LoadPropertyConvert<[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)] P, [DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)] F >()

void Csla.ReadOnlyBase< T >.LoadPropertyConvert<[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)] P,[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)] F >	(	PropertyInfo< P >	propertyInfo,
		F?	newValue )

inlineprotected

Loads a property's managed field with the supplied value calling PropertyHasChanged if the value does change.

Parameters

propertyInfo	PropertyInfo object containing property metadata.
newValue	The new value for the property.

No authorization checks occur when this method is called, and no PropertyChanging or PropertyChanged events are raised. Loading values does not cause validation rules to be invoked.

Exceptions

ArgumentNullException propertyInfo is null.

◆ MarkBusy()

void Csla.ReadOnlyBase< T >.MarkBusy ( )

inlineprotected

Marks the object as being busy (it is running an async operation).

◆ MarkIdle()

void Csla.ReadOnlyBase< T >.MarkIdle ( )

inlineprotected

Marks the object as being not busy (it is not running an async operation).

◆ OnBusyChanged() [1/2]

virtual void Csla.ReadOnlyBase< T >.OnBusyChanged ( BusyChangedEventArgs args )

inlineprotectedvirtual

Raises the BusyChanged event.

Parameters

args	Event arguments.

Exceptions

ArgumentNullException args is null.

◆ OnBusyChanged() [2/2]

void Csla.ReadOnlyBase< T >.OnBusyChanged	(	string	propertyName,
		bool	busy )

inlineprotected

Raises the BusyChanged event.

Parameters

propertyName	Name of the property that has changed.
busy	New busy value.

Exceptions

ArgumentNullException propertyName is null.

◆ OnGetChildren()

override void Csla.ReadOnlyBase< T >.OnGetChildren	(	SerializationInfo	info,
		MobileFormatter	formatter )

inlineprotectedvirtual

Override this method to insert your child object references into the MobileFormatter serialization stream.

Parameters

info	Object containing the data to serialize.
formatter	Reference to MobileFormatter instance. Use this to convert child references to/from reference id values.

Reimplemented from Csla.Core.MobileObject.

◆ OnSetChildren()

override void Csla.ReadOnlyBase< T >.OnSetChildren	(	SerializationInfo	info,
		MobileFormatter	formatter )

inlineprotectedvirtual

Override this method to retrieve your child object references from the MobileFormatter serialization stream.

Parameters

info	Object containing the data to serialize.
formatter	Reference to MobileFormatter instance. Use this to convert child references to/from reference id values.

Reimplemented from Csla.Core.MobileObject.

◆ OnUnhandledAsyncException() [1/2]

virtual void Csla.ReadOnlyBase< T >.OnUnhandledAsyncException ( Core.ErrorEventArgs error )

inlineprotectedvirtual

Raises the UnhandledAsyncException event.

Parameters

error Error arguments.

Exceptions

ArgumentNullException error is null.

◆ OnUnhandledAsyncException() [2/2]

void Csla.ReadOnlyBase< T >.OnUnhandledAsyncException	(	object	originalSender,
		Exception	error )

inlineprotected

Raises the UnhandledAsyncException event.

Parameters

originalSender	Original sender of the event.
error	Exception that occurred.

Exceptions

ArgumentNullException originalSender or error is null.

◆ PropertyIsLoading()

bool Csla.ReadOnlyBase< T >.PropertyIsLoading ( IPropertyInfo propertyInfo )

inlineprotected

Gets a value indicating whether a lazy loaded property is currently being retrieved.

Parameters

propertyInfo Property to check.

Exceptions

ArgumentNullException propertyInfo is null.

◆ ReadOnlyBase()

Csla.ReadOnlyBase< T >.ReadOnlyBase ( )

inlineprotected

Creates an instance of the type.

◆ ReadProperty()

virtual ? object Csla.ReadOnlyBase< T >.ReadProperty ( IPropertyInfo propertyInfo )

inlineprotectedvirtual

Gets a property's value as a specified type.

Parameters

propertyInfo PropertyInfo object containing property metadata.

Exceptions

ArgumentNullException propertyInfo is null.

◆ ReadProperty<[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)] P >()

P? Csla.ReadOnlyBase< T >.ReadProperty<[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)] P > ( PropertyInfo propertyInfo )

inlineprotected

Gets a property's value as a specified type.

Template Parameters

P	Type of the property.

Parameters

propertyInfo PropertyInfo object containing property metadata.

Exceptions

ArgumentNullException propertyInfo is null.

◆ ReadPropertyConvert<[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)] F, [DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)] P >()

P? Csla.ReadOnlyBase< T >.ReadPropertyConvert<[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)] F,[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)] P > ( PropertyInfo< F > propertyInfo )

inlineprotected

Gets a property's value from the list of managed field values, converting the value to an appropriate type.

Template Parameters

F	Type of the field.
P	Type of the property.

Parameters

propertyInfo PropertyInfo object containing property metadata.

Exceptions

ArgumentNullException propertyInfo is null.

◆ RegisterMethod() [1/4]

MethodInfo Csla.ReadOnlyBase< T >.RegisterMethod ( Expression< Action< T > > methodLambdaExpression )

inlinestaticprotected

Registers the method.

Parameters

methodLambdaExpression The method lambda expression.

Exceptions

ArgumentNullException methodLambdaExpression is null.

◆ RegisterMethod() [2/4]

MethodInfo Csla.ReadOnlyBase< T >.RegisterMethod ( string methodName )

inlinestaticprotected

Registers a method for use in Authorization.

Parameters

methodName Method name from nameof()

Exceptions

ArgumentNullException methodName is null.

◆ RegisterMethod() [3/4]

IMemberInfo Csla.ReadOnlyBase< T >.RegisterMethod	(	Type	objectType,
		IMemberInfo	info )

inlinestaticprotected

Indicates that the specified method belongs to the type.

Parameters

objectType	Type of object to which the method belongs.
info	IMemberInfo object for the property.

Returns: The provided IMemberInfo object.

Exceptions

ArgumentNullException objectType or info is null.

◆ RegisterMethod() [4/4]

MethodInfo Csla.ReadOnlyBase< T >.RegisterMethod	(	Type	objectType,
		string	methodName )

inlinestaticprotected

Indicates that the specified method belongs to the type.

Parameters

objectType	Type of object to which the method belongs.
methodName	Name of the method.

Returns: The provided IMemberInfo object.

Exceptions

ArgumentNullException objectType or methodName is null.

◆ RegisterProperty<[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)] P >() [1/12]

PropertyInfo< P > Csla.ReadOnlyBase< T >.RegisterProperty<[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)] P >	(	[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)] Type	objectType,
		PropertyInfo< P >	info )

inlinestaticprotected

Indicates that the specified property belongs to the type.

Template Parameters

P	Type of property.

Parameters

objectType	Type of object to which the property belongs.
info	PropertyInfo object for the property.

Returns: The provided IPropertyInfo object.

Exceptions

ArgumentNullException objectType or info is null.

◆ RegisterProperty<[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)] P >() [2/12]

PropertyInfo Csla.ReadOnlyBase< T >.RegisterProperty<[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)] P > ( Expression< Func< T, object > > propertyLambdaExpression )

inlinestaticprotected

Indicates that the specified property belongs to the business object type.

Template Parameters

P	Type of property

Parameters

propertyLambdaExpression Property Expression

Exceptions

ArgumentNullException propertyLambdaExpression is null.

◆ RegisterProperty<[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)] P >() [3/12]

PropertyInfo< P > Csla.ReadOnlyBase< T >.RegisterProperty<[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)] P >	(	Expression< Func< T, object > >	propertyLambdaExpression,
		RelationshipTypes	relationship )

inlinestaticprotected

Indicates that the specified property belongs to the business object type.

Template Parameters

P	Type of property

Parameters

propertyLambdaExpression	Property Expression
relationship	Relationship with property value.

Exceptions

ArgumentNullException propertyLambdaExpression is null.

◆ RegisterProperty<[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)] P >() [4/12]

PropertyInfo< P > Csla.ReadOnlyBase< T >.RegisterProperty<[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)] P >	(	Expression< Func< T, object > >	propertyLambdaExpression,
		string?	friendlyName )

inlinestaticprotected

Indicates that the specified property belongs to the business object type.

Template Parameters

P	Type of property

Parameters

propertyLambdaExpression	Property Expression
friendlyName	Friendly description for a property to be used in databinding

Exceptions

ArgumentNullException propertyLambdaExpression is null.

◆ RegisterProperty<[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)] P >() [5/12]

PropertyInfo< P > Csla.ReadOnlyBase< T >.RegisterProperty<[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)] P >	(	Expression< Func< T, object > >	propertyLambdaExpression,
		string?	friendlyName,
		P?	defaultValue )

inlinestaticprotected

Indicates that the specified property belongs to the business object type.

Template Parameters

P	Type of property

Parameters

propertyLambdaExpression	Property Expression
friendlyName	Friendly description for a property to be used in databinding
defaultValue	Default Value for the property

Exceptions

ArgumentNullException propertyLambdaExpression is null.

◆ RegisterProperty<[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)] P >() [6/12]

PropertyInfo< P > Csla.ReadOnlyBase< T >.RegisterProperty<[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)] P >	(	Expression< Func< T, object > >	propertyLambdaExpression,
		string?	friendlyName,
		P?	defaultValue,
		RelationshipTypes	relationship )

inlinestaticprotected

Indicates that the specified property belongs to the business object type.

Template Parameters

P	Type of property

Parameters

propertyLambdaExpression	Property Expression
friendlyName	Friendly description for a property to be used in databinding
defaultValue	Default Value for the property
relationship	Relationship with property value.

Exceptions

ArgumentNullException propertyLambdaExpression is null.

◆ RegisterProperty<[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)] P >() [7/12]

PropertyInfo Csla.ReadOnlyBase< T >.RegisterProperty<[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)] P > ( PropertyInfo info )

inlinestaticprotected

Indicates that the specified property belongs to the business object type.

Template Parameters

P	Type of property.

Parameters

info	PropertyInfo object for the property.

Returns: The provided IPropertyInfo object.

Exceptions

ArgumentNullException info is null.

◆ RegisterProperty<[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)] P >() [8/12]

PropertyInfo Csla.ReadOnlyBase< T >.RegisterProperty<[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)] P > ( string propertyName )

inlinestaticprotected

Indicates that the specified property belongs to the business object type.

Template Parameters

P	Type of property

Parameters

propertyName Property name from nameof()

Exceptions

ArgumentException propertyName is null, string.Empty or only consists of white spaces.

◆ RegisterProperty<[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)] P >() [9/12]

PropertyInfo< P > Csla.ReadOnlyBase< T >.RegisterProperty<[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)] P >	(	string	propertyName,
		RelationshipTypes	relationship )

inlinestaticprotected

Indicates that the specified property belongs to the business object type.

Template Parameters

P	Type of property

Parameters

propertyName	Property name from nameof()
relationship	Relationship with property value.

Exceptions

ArgumentException propertyName is null, string.Empty or only consists of white spaces.

◆ RegisterProperty<[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)] P >() [10/12]

PropertyInfo< P > Csla.ReadOnlyBase< T >.RegisterProperty<[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)] P >	(	string	propertyName,
		string?	friendlyName )

inlinestaticprotected

Indicates that the specified property belongs to the business object type.

Template Parameters

P	Type of property

Parameters

propertyName	Property name from nameof()
friendlyName	Friendly description for a property to be used in databinding

Exceptions

ArgumentException propertyName is null, string.Empty or only consists of white spaces.

◆ RegisterProperty<[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)] P >() [11/12]

PropertyInfo< P > Csla.ReadOnlyBase< T >.RegisterProperty<[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)] P >	(	string	propertyName,
		string?	friendlyName,
		P?	defaultValue )

inlinestaticprotected

Indicates that the specified property belongs to the business object type.

Template Parameters

P	Type of property

Parameters

propertyName	Property name from nameof()
friendlyName	Friendly description for a property to be used in databinding
defaultValue	Default Value for the property

Exceptions

ArgumentException propertyName is null, string.Empty or only consists of white spaces.

◆ RegisterProperty<[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)] P >() [12/12]

PropertyInfo< P > Csla.ReadOnlyBase< T >.RegisterProperty<[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)] P >	(	string	propertyName,
		string?	friendlyName,
		P?	defaultValue,
		RelationshipTypes	relationship )

inlinestaticprotected

Indicates that the specified property belongs to the business object type.

Template Parameters

P	Type of property

Parameters

propertyName	Property name from nameof()
friendlyName	Friendly description for a property to be used in databinding
defaultValue	Default Value for the property
relationship	Relationship with property value.

Exceptions

ArgumentException propertyName is null, string.Empty or only consists of white spaces.

◆ ToString()

override string Csla.ReadOnlyBase< T >.ToString ( )

inline

Returns a text representation of this object by returning the GetIdValue value in text form.

◆ WaitForIdle() [1/3]

async Task Csla.ReadOnlyBase< T >.WaitForIdle ( )

inline

Await this method to ensure business object is not busy running async rules.

◆ WaitForIdle() [2/3]

Task Csla.ReadOnlyBase< T >.WaitForIdle ( CancellationToken ct )

inline

Waits for the object to become idle.

Parameters

ct	The cancellation token.

Returns: A task representing the asynchronous operation.

◆ WaitForIdle() [3/3]

Task Csla.ReadOnlyBase< T >.WaitForIdle ( TimeSpan timeout )

inline

Await this method to ensure business object is not busy running async rules.

Parameters

timeout Timeout duration

Property Documentation

◆ ApplicationContext

ApplicationContext Csla.ReadOnlyBase< T >.ApplicationContext

getsetprotected

Gets or sets the current ApplicationContext object.

Implements Csla.Core.IUseApplicationContext.

◆ BusinessRules

BusinessRules Csla.ReadOnlyBase< T >.BusinessRules

getprotected

Provides access to the broken rules functionality.

This property is used within your business logic so you can easily call the AddRule() method to associate business rules with your object's properties.

◆ FieldManager

FieldDataManager Csla.ReadOnlyBase< T >.FieldManager

getprotected

Gets the PropertyManager object for this business object.

◆ IsBusy

virtual bool Csla.ReadOnlyBase< T >.IsBusy

get

Gets a value indicating whether this object or any of its child objects are running an async operation.

◆ IsCanReadPropertyAuthorizationCheckDisabled

virtual bool Csla.ReadOnlyBase< T >.IsCanReadPropertyAuthorizationCheckDisabled = false

getprotected

Gets or sets if CanReadProperty(IPropertyInfo) performs an authorization check or not.
true means read is always allowed. false means an authorization check is always performed.

◆ IsSelfBusy

virtual bool Csla.ReadOnlyBase< T >.IsSelfBusy

get

Gets a value indicating whether this object is running an async operation.

Event Documentation

◆ BusyChanged

BusyChangedEventHandler? Csla.ReadOnlyBase< T >.BusyChanged

addremove

Event raised when the IsBusy property value has changed.

◆ UnhandledAsyncException

EventHandler<Core.ErrorEventArgs>? Csla.ReadOnlyBase< T >.UnhandledAsyncException

addremove

Event raised when an exception occurs on a background thread during an asynchronous operation.

The documentation for this class was generated from the following file:

csla/Source/Csla/ReadOnlyBase.cs

Public Member Functions

Protected Member Functions

Static Protected Member Functions

Properties

Events

Detailed Description

Member Function Documentation

◆ AddBusinessRules()

◆ CanExecuteMethod() [1/3]

◆ CanExecuteMethod() [2/3]

◆ CanExecuteMethod() [3/3]

◆ CanReadProperty() [1/3]

◆ CanReadProperty() [2/3]

◆ CanReadProperty() [3/3]

◆ Child_OnDataPortalException()

◆ Child_OnDataPortalInvoke()

◆ Child_OnDataPortalInvokeComplete()

◆ Clone()

◆ DataPortal_OnDataPortalException()

◆ DataPortal_OnDataPortalInvoke()

◆ DataPortal_OnDataPortalInvokeComplete()

◆ Deserialized()

◆ GetClone()

◆ GetIdValue()

◆ GetProperty()

◆ GetProperty< P >() [1/2]

◆ GetProperty< P >() [2/2]

◆ GetProperty<[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)] P >() [1/4]

◆ GetProperty<[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)] P >() [2/4]

◆ GetProperty<[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)] P >() [3/4]

◆ GetProperty<[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)] P >() [4/4]

◆ GetPropertyConvert<[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)] F, [DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)] P >() [1/4]

◆ GetPropertyConvert<[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)] F, [DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)] P >() [2/4]

◆ GetPropertyConvert<[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)] F, [DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)] P >() [3/4]

◆ GetPropertyConvert<[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)] F, [DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)] P >() [4/4]

◆ Initialize()

◆ LazyGetProperty<[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)] P >()

◆ LazyGetPropertyAsync<[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)] P >()

◆ LazyReadProperty<[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)] P >()

◆ LazyReadPropertyAsync<[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)] P >()

◆ LoadProperty()

◆ LoadProperty<[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)] P >()

◆ LoadPropertyAsync<[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)] R >()

◆ LoadPropertyConvert<[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)] P, [DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)] F >()

◆ MarkBusy()

◆ MarkIdle()

◆ OnBusyChanged() [1/2]

◆ OnBusyChanged() [2/2]

◆ OnGetChildren()

◆ OnSetChildren()

◆ OnUnhandledAsyncException() [1/2]

◆ OnUnhandledAsyncException() [2/2]

◆ PropertyIsLoading()

◆ ReadOnlyBase()

◆ ReadProperty()

◆ ReadProperty<[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)] P >()

◆ ReadPropertyConvert<[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)] F, [DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)] P >()

◆ RegisterMethod() [1/4]

◆ RegisterMethod() [2/4]

◆ RegisterMethod() [3/4]

◆ RegisterMethod() [4/4]

◆ RegisterProperty<[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)] P >() [1/12]

◆ RegisterProperty<[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)] P >() [2/12]

◆ RegisterProperty<[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)] P >() [3/12]

◆ RegisterProperty<[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)] P >() [4/12]

◆ RegisterProperty<[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)] P >() [5/12]

◆ RegisterProperty<[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)] P >() [6/12]

◆ RegisterProperty<[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)] P >() [7/12]

◆ RegisterProperty<[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)] P >() [8/12]

◆ RegisterProperty<[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)] P >() [9/12]

◆ RegisterProperty<[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)] P >() [10/12]

◆ RegisterProperty<[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)] P >() [11/12]

◆ RegisterProperty<[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)] P >() [12/12]

◆ ToString()

◆ WaitForIdle() [1/3]

◆ WaitForIdle() [2/3]

◆ WaitForIdle() [3/3]

Property Documentation

◆ ApplicationContext

◆ BusinessRules