142 lines
3.1 KiB
Groff
142 lines
3.1 KiB
Groff
.TH "CampusAppWP8.Model.Utility.UrlParamModel" 3 "Thu Aug 15 2013" "CampusAppWp8" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
CampusAppWP8.Model.Utility.UrlParamModel \-
|
|
.PP
|
|
This class is a \fBModel\fP for the URLParameter like GET-Parameter
|
|
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
.PP
|
|
Inherited by \fBCampusAppWP8\&.Model\&.Utility\&.CleanUrlParamModel\fP\&.
|
|
.SS "Public Member Functions"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "\fBUrlParamModel\fP (string \fBkey\fP)"
|
|
.br
|
|
.RI "\fIInitializes a new instance of the \fBUrlParamModel\fP class\&. \fP"
|
|
.ti -1c
|
|
.RI "\fBUrlParamModel\fP (string \fBkey\fP, string value)"
|
|
.br
|
|
.RI "\fIInitializes a new instance of the \fBUrlParamModel\fP class\&. \fP"
|
|
.ti -1c
|
|
.RI "virtual bool \fBIsParamValid\fP ()"
|
|
.br
|
|
.RI "\fIMethod check if the parameter is valid \fP"
|
|
.ti -1c
|
|
.RI "override string \fBToString\fP ()"
|
|
.br
|
|
.RI "\fIMethod return a formatted string like Key=Value \fP"
|
|
.in -1c
|
|
.SS "Protected Attributes"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "readonly string \fBkey\fP"
|
|
.br
|
|
.RI "\fIVariable of the key \fP"
|
|
.in -1c
|
|
.SS "Properties"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "string \fBValue\fP\fC [get, set]\fP"
|
|
.br
|
|
.RI "\fIGets or sets the value of the Parameter \fP"
|
|
.ti -1c
|
|
.RI "string \fBKey\fP\fC [get]\fP"
|
|
.br
|
|
.RI "\fIGets the key of the parameter \fP"
|
|
.ti -1c
|
|
.RI "virtual string \fBParamToken\fP\fC [get]\fP"
|
|
.br
|
|
.RI "\fIGets the token, which indicate that the parameterList started \fP"
|
|
.in -1c
|
|
.SH "Detailed Description"
|
|
.PP
|
|
This class is a \fBModel\fP for the URLParameter like GET-Parameter
|
|
|
|
|
|
.SH "Constructor & Destructor Documentation"
|
|
.PP
|
|
.SS "CampusAppWP8\&.Model\&.Utility\&.UrlParamModel\&.UrlParamModel (stringkey)"
|
|
|
|
.PP
|
|
Initializes a new instance of the \fBUrlParamModel\fP class\&.
|
|
.PP
|
|
\fBParameters:\fP
|
|
.RS 4
|
|
\fIkey\fP the key for the parameter
|
|
.RE
|
|
.PP
|
|
|
|
.SS "CampusAppWP8\&.Model\&.Utility\&.UrlParamModel\&.UrlParamModel (stringkey, stringvalue)"
|
|
|
|
.PP
|
|
Initializes a new instance of the \fBUrlParamModel\fP class\&.
|
|
.PP
|
|
\fBParameters:\fP
|
|
.RS 4
|
|
\fIkey\fP the key for the parameter
|
|
.RE
|
|
.PP
|
|
>
|
|
.PP
|
|
\fBParameters:\fP
|
|
.RS 4
|
|
\fIvalue\fP value of the parameter
|
|
.RE
|
|
.PP
|
|
|
|
.SH "Member Function Documentation"
|
|
.PP
|
|
.SS "virtual bool CampusAppWP8\&.Model\&.Utility\&.UrlParamModel\&.IsParamValid ()\fC [virtual]\fP"
|
|
|
|
.PP
|
|
Method check if the parameter is valid
|
|
.PP
|
|
\fBReturns:\fP
|
|
.RS 4
|
|
true if is it valid, otherwise false
|
|
.RE
|
|
.PP
|
|
|
|
.SS "override string CampusAppWP8\&.Model\&.Utility\&.UrlParamModel\&.ToString ()"
|
|
|
|
.PP
|
|
Method return a formatted string like Key=Value
|
|
.PP
|
|
\fBReturns:\fP
|
|
.RS 4
|
|
return formatted string
|
|
.RE
|
|
.PP
|
|
|
|
.SH "Member Data Documentation"
|
|
.PP
|
|
.SS "readonly string CampusAppWP8\&.Model\&.Utility\&.UrlParamModel\&.key\fC [protected]\fP"
|
|
|
|
.PP
|
|
Variable of the key
|
|
.SH "Property Documentation"
|
|
.PP
|
|
.SS "string CampusAppWP8\&.Model\&.Utility\&.UrlParamModel\&.Key\fC [get]\fP"
|
|
|
|
.PP
|
|
Gets the key of the parameter
|
|
.SS "virtual string CampusAppWP8\&.Model\&.Utility\&.UrlParamModel\&.ParamToken\fC [get]\fP"
|
|
|
|
.PP
|
|
Gets the token, which indicate that the parameterList started
|
|
.SS "string CampusAppWP8\&.Model\&.Utility\&.UrlParamModel\&.Value\fC [get]\fP, \fC [set]\fP"
|
|
|
|
.PP
|
|
Gets or sets the value of the Parameter
|
|
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for CampusAppWp8 from the source code\&.
|