C# Class Rock.UniversalSearch.IndexModels.IndexModelBase

Base Index Model

Inheritance: System.Dynamic.DynamicObject, Lava.ILiquidizable

Mostrar archivo Open project: NewSpring/Rock Class Usage Examples

Private Properties

Property	Type	Description

Public Methods

Method	Description
Contains ( object>.KeyValuePair item, bool includeInstanceProperties = false ) : bool	Determines whether [contains] [the specified item].
ContainsKey ( object key ) : bool	Determines whether the specified key contains key.
FormatSearchResult ( Person person, object>.Dictionary displayOptions = null ) : FormattedSearchResult	Formats the search result.
GetDocumentUrl ( object>.Dictionary displayOptions = null ) : string	Gets the document URL.
GetDynamicMemberNames ( ) : IEnumerable	Returns the enumeration of all dynamic member names.
GetProperties ( bool includeInstanceProperties = false ) : object>>.IEnumerable	Gets the properties.
IndexModelBase ( ) : System	Initializes a new instance of the IndexModelBase class.
ToLiquid ( ) : object	Returns liquid for the object
TryGetMember ( GetMemberBinder binder, object &result ) : bool	Provides the implementation for operations that get member values. Classes derived from the T:System.Dynamic.DynamicObject class can override this method to specify dynamic behavior for operations such as getting a value for a property.
TrySetMember ( SetMemberBinder binder, object value ) : bool	Provides the implementation for operations that set member values. Classes derived from the T:System.Dynamic.DynamicObject class can override this method to specify dynamic behavior for operations such as setting a value for a property.
this ( object key ) : object	Gets the System.Object with the specified key.
this ( string key ) : object	Gets or sets the System.Object with the specified key.

Protected Methods

Method	Description
AddIndexableAttributes ( IndexModelBase indexModel, IHasAttributes sourceModel ) : void	Adds the indexable attributes.
GetProperty ( object instance, string name, object &result ) : bool	Gets the property.
SetProperty ( object instance, string name, object value ) : bool	Sets the property.

Method Details

AddIndexableAttributes() protected static method

Adds the indexable attributes.

protected static AddIndexableAttributes ( IndexModelBase indexModel, IHasAttributes sourceModel ) : void
indexModel	IndexModelBase	The index model.
sourceModel	IHasAttributes	The source model.
return	void

Contains() public method

Determines whether [contains] [the specified item].

public Contains ( object>.KeyValuePair item, bool includeInstanceProperties = false ) : bool
item	object>.KeyValuePair	The item.
includeInstanceProperties	bool	if set to true [include instance properties].
return	bool

ContainsKey() public method

Determines whether the specified key contains key.

public ContainsKey ( object key ) : bool
key	object	The key.
return	bool

FormatSearchResult() public method

Formats the search result.

public FormatSearchResult ( Person person, object>.Dictionary displayOptions = null ) : FormattedSearchResult
person	Person	The person.
displayOptions	object>.Dictionary	The display options.
return	FormattedSearchResult

GetDocumentUrl() public method

Gets the document URL.

public GetDocumentUrl ( object>.Dictionary displayOptions = null ) : string
displayOptions	object>.Dictionary
return	string

GetDynamicMemberNames() public method

Returns the enumeration of all dynamic member names.

public GetDynamicMemberNames ( ) : IEnumerable
return	IEnumerable

GetProperties() public method

Gets the properties.

public GetProperties ( bool includeInstanceProperties = false ) : object>>.IEnumerable
includeInstanceProperties	bool	if set to true [include instance properties].
return	object>>.IEnumerable

GetProperty() protected method

Gets the property.

protected GetProperty ( object instance, string name, object &result ) : bool
instance	object	The instance.
name	string	The name.
result	object	The result.
return	bool

IndexModelBase() public method

Initializes a new instance of the IndexModelBase class.

public IndexModelBase ( ) : System
return	System

SetProperty() protected method

Sets the property.

protected SetProperty ( object instance, string name, object value ) : bool
instance	object	The instance.
name	string	The name.
value	object	The value.
return	bool

ToLiquid() public method

Returns liquid for the object

public ToLiquid ( ) : object
return	object

TryGetMember() public method

Provides the implementation for operations that get member values. Classes derived from the T:System.Dynamic.DynamicObject class can override this method to specify dynamic behavior for operations such as getting a value for a property.

public TryGetMember ( GetMemberBinder binder, object &result ) : bool
binder	System.Dynamic.GetMemberBinder	Provides information about the object that called the dynamic operation. The binder.Name property provides the name of the member on which the dynamic operation is performed. For example, for the Console.WriteLine(sampleObject.SampleProperty) statement, where sampleObject is an instance of the class derived from the class, binder.Name returns "SampleProperty". The binder.IgnoreCase property specifies whether the member name is case-sensitive.
result	object	The result of the get operation. For example, if the method is called for a property, you can assign the property value to .
return	bool

TrySetMember() public method

Provides the implementation for operations that set member values. Classes derived from the T:System.Dynamic.DynamicObject class can override this method to specify dynamic behavior for operations such as setting a value for a property.

public TrySetMember ( SetMemberBinder binder, object value ) : bool
binder	System.Dynamic.SetMemberBinder	Provides information about the object that called the dynamic operation. The binder.Name property provides the name of the member to which the value is being assigned. For example, for the statement sampleObject.SampleProperty = "Test", where sampleObject is an instance of the class derived from the class, binder.Name returns "SampleProperty". The binder.IgnoreCase property specifies whether the member name is case-sensitive.
value	object	The value to set to the member. For example, for sampleObject.SampleProperty = "Test", where sampleObject is an instance of the class derived from the class, the is "Test".
return	bool

this() public method

Gets the System.Object with the specified key.

public this ( object key ) : object
key	object	The key.
return	object

this() public method

Gets or sets the System.Object with the specified key.

public this ( string key ) : object
key	string	The key.
return	object