132 lines
2.9 KiB
Groff
132 lines
2.9 KiB
Groff
.TH "CampusAppWP8.Model.XmlModel< T >" 3 "Thu Aug 15 2013" "CampusAppWp8" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
CampusAppWP8.Model.XmlModel< T > \-
|
|
.PP
|
|
Xml model io handler class\&.
|
|
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
.PP
|
|
Inherits \fBCampusAppWP8\&.MainModel< T >\fP\&.
|
|
.SS "Public Member Functions"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "\fBXmlModel\fP (\fBModelType\fP modelType, string fileName, string url)"
|
|
.br
|
|
.RI "\fIInitializes a new instance of the XmlModel{T} class\&. \fP"
|
|
.ti -1c
|
|
.RI "\fBXmlModel\fP (\fBModelType\fP modelType, string sourceName)"
|
|
.br
|
|
.RI "\fIInitializes a new instance of the XmlModel{T} class\&. Use only if the model io type is file or feed, not both\&. \fP"
|
|
.in -1c
|
|
.SS "Protected Member Functions"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "override bool \fBDeserializeModel\fP (byte[] modelData)"
|
|
.br
|
|
.RI "\fICreate the model from a xml byte array\&. \fP"
|
|
.ti -1c
|
|
.RI "override byte[] \fBSerializeModel\fP ()"
|
|
.br
|
|
.RI "\fISerializes the model to a byte array\&. \fP"
|
|
.in -1c
|
|
.SS "Properties"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "string \fBValidRootName\fP\fC [get, set]\fP"
|
|
.br
|
|
.RI "\fIGets or sets for the name of the root-tag \fP"
|
|
.in -1c
|
|
.SS "Additional Inherited Members"
|
|
.SH "Detailed Description"
|
|
.PP
|
|
Xml model io handler class\&.
|
|
|
|
|
|
.PP
|
|
\fBTemplate Parameters:\fP
|
|
.RS 4
|
|
\fIT\fP model type
|
|
.RE
|
|
.PP
|
|
|
|
.SH "Constructor & Destructor Documentation"
|
|
.PP
|
|
.SS "CampusAppWP8\&.Model\&.XmlModel< T >\&.XmlModel (\fBModelType\fPmodelType, stringfileName, stringurl)"
|
|
|
|
.PP
|
|
Initializes a new instance of the XmlModel{T} class\&.
|
|
.PP
|
|
\fBParameters:\fP
|
|
.RS 4
|
|
\fImodelType\fP model io type
|
|
.br
|
|
\fIfileName\fP filename of the data file
|
|
.br
|
|
\fIurl\fP url of the feed data
|
|
.RE
|
|
.PP
|
|
|
|
.SS "CampusAppWP8\&.Model\&.XmlModel< T >\&.XmlModel (\fBModelType\fPmodelType, stringsourceName)"
|
|
|
|
.PP
|
|
Initializes a new instance of the XmlModel{T} class\&. Use only if the model io type is file or feed, not both\&.
|
|
.PP
|
|
\fBParameters:\fP
|
|
.RS 4
|
|
\fImodelType\fP model io type
|
|
.br
|
|
\fIsourceName\fP name of the file or the url of the feed
|
|
.RE
|
|
.PP
|
|
|
|
.SH "Member Function Documentation"
|
|
.PP
|
|
.SS "override bool CampusAppWP8\&.Model\&.XmlModel< T >\&.DeserializeModel (byte[]modelData)\fC [protected]\fP, \fC [virtual]\fP"
|
|
|
|
.PP
|
|
Create the model from a xml byte array\&.
|
|
.PP
|
|
\fBParameters:\fP
|
|
.RS 4
|
|
\fImodelData\fP model data
|
|
.RE
|
|
.PP
|
|
\fBReturns:\fP
|
|
.RS 4
|
|
true, if succeeded
|
|
.RE
|
|
.PP
|
|
|
|
.PP
|
|
Implements \fBCampusAppWP8\&.MainModel< T >\fP\&.
|
|
.SS "override byte [] CampusAppWP8\&.Model\&.XmlModel< T >\&.SerializeModel ()\fC [protected]\fP, \fC [virtual]\fP"
|
|
|
|
.PP
|
|
Serializes the model to a byte array\&.
|
|
.PP
|
|
\fBReturns:\fP
|
|
.RS 4
|
|
model data
|
|
.RE
|
|
.PP
|
|
|
|
.PP
|
|
Implements \fBCampusAppWP8\&.MainModel< T >\fP\&.
|
|
.SH "Property Documentation"
|
|
.PP
|
|
.SS "string CampusAppWP8\&.Model\&.XmlModel< T >\&.ValidRootName\fC [get]\fP, \fC [set]\fP, \fC [protected]\fP"
|
|
|
|
.PP
|
|
Gets or sets for the name of the root-tag
|
|
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for CampusAppWp8 from the source code\&.
|