C# Class Rock.Extension.Component

Inheritance: Rock.Attribute.IHasAttributes

Mostrar archivo Open project: NewSpring/Rock

Public Methods

Method	Description
Component ( ) : System	Initializes a new instance of the Component class.
Component ( bool updateAttributes ) : System	Initializes a new instance of the Component class.
GetAttributeValue ( string key ) : string	Gets the value of an attribute key.
GetAttributeValues ( string key ) : List	Gets the value of an attribute key - splitting that delimited value into a list of strings.
InitializeAttributeValues ( System request, string rootUrl ) : void	Method that is called before attribute values are updated. Components can override this to perform any needed initialization of attribute values.
IsAllowedByDefault ( string action ) : bool	If a user or role is not specifically allowed or denied to perform the selected action, return `true` if they should be allowed anyway or `false` if not.
IsAuthorized ( string action, Model person ) : bool	Return `true` if the user is authorized to perform the selected action on this object.
IsPrivate ( string action, Model person ) : bool	Determines whether the specified action is private (Only the current user has access).
MakePrivate ( string action, Model person, RockContext rockContext = null ) : void	Makes the action on the current entity private (Only the current user will have access).
MakeUnPrivate ( string action, Model person, RockContext rockContext = null ) : void	If action on the current entity is private, removes security that made it private.
SetAttributeValue ( string key, string value ) : void	Sets the value of an attribute key in memory. Note, this will not persist value to database
ValidateAttributeValues ( string &errorMessage ) : bool	Method that is called when attribute values are updated. Components can override this to perform any needed setup/validation based on current attribute values.

Private Methods

Method	Description
UpdateAttributes ( ) : void

Method Details

Component() public method

Initializes a new instance of the Component class.

public Component ( ) : System
return	System

Component() public method

Initializes a new instance of the Component class.

public Component ( bool updateAttributes ) : System
updateAttributes	bool	if set to true [update attributes].
return	System

GetAttributeValue() public method

Gets the value of an attribute key.

public GetAttributeValue ( string key ) : string
key	string	The key.
return	string

GetAttributeValues() public method

Gets the value of an attribute key - splitting that delimited value into a list of strings.

public GetAttributeValues ( string key ) : List
key	string	The key.
return	List

InitializeAttributeValues() public method

Method that is called before attribute values are updated. Components can override this to perform any needed initialization of attribute values.

public InitializeAttributeValues ( System request, string rootUrl ) : void
request	System	The request.
rootUrl	string	The root URL.
return	void

IsAllowedByDefault() public method

If a user or role is not specifically allowed or denied to perform the selected action, return true if they should be allowed anyway or false if not.

public IsAllowedByDefault ( string action ) : bool
action	string	The action.
return	bool

IsAuthorized() public method

Return true if the user is authorized to perform the selected action on this object.

public IsAuthorized ( string action, Model person ) : bool
action	string	The action.
person	Model	The person.
return	bool

IsPrivate() public method

Determines whether the specified action is private (Only the current user has access).

public IsPrivate ( string action, Model person ) : bool
action	string	The action.
person	Model	The person.
return	bool

MakePrivate() public method

Makes the action on the current entity private (Only the current user will have access).

public MakePrivate ( string action, Model person, RockContext rockContext = null ) : void
action	string	The action.
person	Model	The person.
rockContext	RockContext	The rock context.
return	void

MakeUnPrivate() public method

If action on the current entity is private, removes security that made it private.

public MakeUnPrivate ( string action, Model person, RockContext rockContext = null ) : void
action	string	The action.
person	Model	The person.
rockContext	RockContext	The rock context.
return	void

SetAttributeValue() public method

Sets the value of an attribute key in memory. Note, this will not persist value to database

public SetAttributeValue ( string key, string value ) : void
key	string	The key.
value	string	The value.
return	void

ValidateAttributeValues() public method

Method that is called when attribute values are updated. Components can override this to perform any needed setup/validation based on current attribute values.

public ValidateAttributeValues ( string &errorMessage ) : bool
errorMessage	string	The error message.
return	bool