Files
win8phoneApp/Doc/man/man3/CampusAppWPortalLib8_Model_Utility_UrlParamModel.3
2013-10-18 09:32:53 +02:00

138 lines
3.5 KiB
Groff

.TH "CampusAppWPortalLib8.Model.Utility.UrlParamModel" 3 "Fri Oct 18 2013" "Version 1.0.0" "CampusAppW8" \" -*- nroff -*-
.ad l
.nh
.SH NAME
CampusAppWPortalLib8.Model.Utility.UrlParamModel \-
.PP
This class is a \fBModel\fP for the URLParameter like GET-Parameter\&.
.SH SYNOPSIS
.br
.PP
.PP
Inherited by \fBCampusAppWPortalLib8\&.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\&.
Stubbfel, 15\&.10\&.2013\&.
.SH "Constructor & Destructor Documentation"
.PP
.SS "CampusAppWPortalLib8\&.Model\&.Utility\&.UrlParamModel\&.UrlParamModel (stringkey)"
.PP
Initializes a new instance of the \fBUrlParamModel\fP class\&. Stubbfel, 15\&.10\&.2013\&.
.PP
\fBParameters:\fP
.RS 4
\fIkey\fP the key for the parameter\&.
.RE
.PP
.SS "CampusAppWPortalLib8\&.Model\&.Utility\&.UrlParamModel\&.UrlParamModel (stringkey, stringvalue)"
.PP
Initializes a new instance of the \fBUrlParamModel\fP class\&. Stubbfel, 15\&.10\&.2013\&.
.PP
\fBParameters:\fP
.RS 4
\fIkey\fP the key for the parameter\&.
.br
\fIvalue\fP value of the parameter\&.
.RE
.PP
.SH "Member Function Documentation"
.PP
.SS "virtual bool CampusAppWPortalLib8\&.Model\&.Utility\&.UrlParamModel\&.IsParamValid ()\fC [virtual]\fP"
.PP
Method check if the parameter is valid\&. Stubbfel, 15\&.10\&.2013\&.
.PP
\fBReturns:\fP
.RS 4
true if is it valid, otherwise false\&.
.RE
.PP
.SS "override string CampusAppWPortalLib8\&.Model\&.Utility\&.UrlParamModel\&.ToString ()"
.PP
Method return a formatted string like Key=Value\&. Stubbfel, 15\&.10\&.2013\&.
.PP
\fBSee Also:\fP
.RS 4
M:System\&.Object\&.ToString()
.PP
.RE
.PP
.SH "Member Data Documentation"
.PP
.SS "readonly string CampusAppWPortalLib8\&.Model\&.Utility\&.UrlParamModel\&.key\fC [protected]\fP"
.PP
Variable of the key\&.
.SH "Property Documentation"
.PP
.SS "string CampusAppWPortalLib8\&.Model\&.Utility\&.UrlParamModel\&.Key\fC [get]\fP"
.PP
Gets the key of the parameter\&. The key\&.
.SS "virtual string CampusAppWPortalLib8\&.Model\&.Utility\&.UrlParamModel\&.ParamToken\fC [get]\fP"
.PP
Gets the token, which indicate that the parameterList started\&. The parameter token\&.
.SS "string CampusAppWPortalLib8\&.Model\&.Utility\&.UrlParamModel\&.Value\fC [get]\fP, \fC [set]\fP"
.PP
Gets or sets the value of the Parameter\&. The value\&.
.SH "Author"
.PP
Generated automatically by Doxygen for CampusAppW8 from the source code\&.