ICustomNavigationItemConfiguration (v2) Plugin Supplementary Type

Ben Tiedt — Tue, 19 Nov 2019 19:38:46 GMT

Current Revision posted to API Documentation by Ben Tiedt on 11/19/2019 19:38:46

ICustomNavigationItemConfiguration is defined in the Telligent.Evolution.Extensibility.UI.Version2 namespace of Telligent.Evolution.Platform.dll

Definition

interface ICustomNavigationItemConfiguration
{
	bool? GetBoolValue(string propertyName, bool? defaultValue);
	[[Color Plugin Supplementary Type|Color]] GetColorValue(string propertyName, [[Color Plugin Supplementary Type|Color]] defaultValue);
	string GetCustomValue(string propertyName, string defaultValue);
	DateTime? GetDateTimeValue(string propertyName, DateTime? defaultValue);
	double? GetDoubleValue(string propertyName, double? defaultValue);
	Guid? GetGuidValue(string propertyName, Guid? defaultValue);
	string GetHtmlValue(string propertyName, string defaultValue);
	int? GetIntValue(string propertyName, int? defaultValue);
	string GetSerializedConfiguration();
	string GetStringValue(string propertyName, string defaultValue);
	[[Unit Plugin Supplementary Type|Unit]] GetUnitValue(string propertyName, [[Unit Plugin Supplementary Type|Unit]] defaultValue);
	Uri[] GetUrlListValue(string propertyName, Uri[] defaultValue);
	Uri GetUrlValue(string propertyName, Uri defaultValue);
	void SetBoolValue(string propertyName, bool? value);
	void SetColorValue(string propertyName, [[Color Plugin Supplementary Type|Color]] value);
	void SetCustomValue(string propertyName, string value);
	void SetDateTimeValue(string propertyName, DateTime? value);
	void SetDoubleValue(string propertyName, double? value);
	void SetGuidValue(string propertyName, Guid? value);
	void SetHtmlValue(string propertyName, string value);
	void SetIntValue(string propertyName, int? value);
	void SetStringValue(string propertyName, string value);
	void SetUnitValue(string propertyName, [[Unit Plugin Supplementary Type|Unit]] value);
	void SetUrlListValue(string propertyName, Uri[] value);
	void SetUrlValue(string propertyName, Uri value);
}

Methods

bool? GetBoolValue(string propertyName, bool? defaultValue);

Parameters

Name	Type	Description	Required	Default	Options
propertyName	`string`	Property Name	Required
defaultValue	`bool?`	Default Value	Required

Return Type

bool?

Color GetColorValue(string propertyName, Color defaultValue);

Parameters

Name	Type	Description	Required	Default	Options
propertyName	`string`	Property Name	Required
defaultValue	`[[Color Plugin Supplementary Type\|Color]]`	Default Value	Required

Return Type

[[Color Plugin Supplementary Type|Color]]

string GetCustomValue(string propertyName, string defaultValue);

Parameters

Name	Type	Description	Required	Default	Options
propertyName	`string`	Property Name	Required
defaultValue	`string`	Default Value	Required

Return Type

string

DateTime? GetDateTimeValue(string propertyName, DateTime? defaultValue);

Parameters

Name	Type	Description	Required	Default	Options
propertyName	`string`	Property Name	Required
defaultValue	`DateTime?`	Default Value	Required

Return Type

DateTime?

double? GetDoubleValue(string propertyName, double? defaultValue);

Parameters

Name	Type	Description	Required	Default	Options
propertyName	`string`	Property Name	Required
defaultValue	`double?`	Default Value	Required

Return Type

double?

Guid? GetGuidValue(string propertyName, Guid? defaultValue);

Parameters

Name	Type	Description	Required	Default	Options
propertyName	`string`	Property Name	Required
defaultValue	`Guid?`	Default Value	Required

Return Type

Guid?

string GetHtmlValue(string propertyName, string defaultValue);

Parameters

Name	Type	Description	Required	Default	Options
propertyName	`string`	Property Name	Required
defaultValue	`string`	Default Value	Required

Return Type

string

int? GetIntValue(string propertyName, int? defaultValue);

Parameters

Name	Type	Description	Required	Default	Options
propertyName	`string`	Property Name	Required
defaultValue	`int?`	Default Value	Required

Return Type

int?

string GetSerializedConfiguration();

Return Type

string

string GetStringValue(string propertyName, string defaultValue);

Parameters

Name	Type	Description	Required	Default	Options
propertyName	`string`	Property Name	Required
defaultValue	`string`	Default Value	Required

Return Type

string

Unit GetUnitValue(string propertyName, Unit defaultValue);

Parameters

Name	Type	Description	Required	Default	Options
propertyName	`string`	Property Name	Required
defaultValue	`[[Unit Plugin Supplementary Type\|Unit]]`	Default Value	Required

Return Type

[[Unit Plugin Supplementary Type|Unit]]

Uri[] GetUrlListValue(string propertyName, Uri[] defaultValue);

Parameters

Name	Type	Description	Required	Default	Options
propertyName	`string`	Property Name	Required
defaultValue	`Uri[]`	Default Value	Required

Return Type

Uri[]

Uri GetUrlValue(string propertyName, Uri defaultValue);

Parameters

Name	Type	Description	Required	Default	Options
propertyName	`string`	Property Name	Required
defaultValue	`Uri`	Default Value	Required

Return Type

Uri

void SetBoolValue(string propertyName, bool? value);

Parameters

Name	Type	Description	Required	Default	Options
propertyName	`string`	Property Name	Required
value	`bool?`	Value	Required

void SetColorValue(string propertyName, Color value);

Parameters

Name	Type	Description	Required	Default	Options
propertyName	`string`	Property Name	Required
value	`[[Color Plugin Supplementary Type\|Color]]`	Value	Required

void SetCustomValue(string propertyName, string value);

Parameters

Name	Type	Description	Required	Default	Options
propertyName	`string`	Property Name	Required
value	`string`	Value	Required

void SetDateTimeValue(string propertyName, DateTime? value);

Parameters

Name	Type	Description	Required	Default	Options
propertyName	`string`	Property Name	Required
value	`DateTime?`	Value	Required

void SetDoubleValue(string propertyName, double? value);

Parameters

Name	Type	Description	Required	Default	Options
propertyName	`string`	Property Name	Required
value	`double?`	Value	Required

void SetGuidValue(string propertyName, Guid? value);

Parameters

Name	Type	Description	Required	Default	Options
propertyName	`string`	Property Name	Required
value	`Guid?`	Value	Required

void SetHtmlValue(string propertyName, string value);

Parameters

Name	Type	Description	Required	Default	Options
propertyName	`string`	Property Name	Required
value	`string`	Value	Required

void SetIntValue(string propertyName, int? value);

Parameters

Name	Type	Description	Required	Default	Options
propertyName	`string`	Property Name	Required
value	`int?`	Value	Required

void SetStringValue(string propertyName, string value);

Parameters

Name	Type	Description	Required	Default	Options
propertyName	`string`	Property Name	Required
value	`string`	Value	Required

void SetUnitValue(string propertyName, Unit value);

Parameters

Name	Type	Description	Required	Default	Options
propertyName	`string`	Property Name	Required
value	`[[Unit Plugin Supplementary Type\|Unit]]`	Value	Required

void SetUrlListValue(string propertyName, Uri[] value);

Parameters

Name	Type	Description	Required	Default	Options
propertyName	`string`	Property Name	Required
value	`Uri[]`	Value	Required

void SetUrlValue(string propertyName, Uri value);

Parameters

Name	Type	Description	Required	Default	Options
propertyName	`string`	Property Name	Required
value	`Uri`	Value	Required