Page last modified 21:58, 29 Apr 2010 by arnec
MindTouch Community Portal > MindTouch Community Portal > Reference > MindTouch DReAM Framework > MindTouch.Dream > DreamContext Class > GetParam Method
Table of contents
- 1. GetParam(string key)
- 1.1. Remarks
- 1.2. Parameters
- 1.3. Returns
- 2. Exceptions
- 3. GetParam(string key)
- 3.1. Generic Parameters
- 3.1.1. Parameter T
- 3.2. Parameters
- 3.3. Returns
- 3.1. Generic Parameters
- 4. GetParam(string key, string def)
- 4.1. Parameters
- 4.2. Returns
- 5. GetParam(string key, T def)
- 5.1. Generic Parameters
- 5.1.1. Parameter T
- 5.2. Parameters
- 5.3. Returns
- 5.1. Generic Parameters
| Table of Contents
|
GetParam(string key)
public string GetParam(string key);
Get a named parameter.
Remarks
Will throw MindTouch.Dream.DreamAbortException if the named parameter does not exist.
Parameters
| Name | Type | Description |
|---|---|---|
| key | string | MindTouch.Dream.DreamFeatureParamAttribute name. |
Returns
Type: string
Text value of parameter.
Exceptions
| Exception | Condition |
|---|---|
| DreamAbortException | Throws if parameter does not exist. |
GetParam(string key)
public T GetParam(string key);
Get a named parameter.
Generic Parameters
Parameter T
Type to convert parameter to.
Constraints:
none
Parameters
| Name | Type | Description |
|---|---|---|
| key | string | MindTouch.Dream.DreamFeatureParamAttribute name. |
Returns
Type: T
Parameter value converted to requested type.
GetParam(string key, string def)
public string GetParam(string key, string def);
Get a named parameter.
Parameters
| Name | Type | Description |
|---|---|---|
| key | string | MindTouch.Dream.DreamFeatureParamAttribute name. |
| def | string | Default value to return in case parameter is not defined. |
Returns
Type: string
Text value of parameter
GetParam(string key, T def)
public T GetParam(string key, T def);
Get a named parameter.
Generic Parameters
Parameter T
Type to convert parameter to.
Constraints:
- struct
Parameters
| Name | Type | Description |
|---|---|---|
| key | string | MindTouch.Dream.DreamFeatureParamAttribute name. |
| def | T | Default value to return in case parameter is not defined. |
Returns
Type: T
Parameter value converted to requested type.
- Was this page helpful?
- Tag page
- What links here
| Images 0 | ||
|---|---|---|
| No images to display in the gallery. |
You must login to post a comment.
Copyright © 2011 MindTouch, Inc. Powered by