30 lines
16 KiB
HTML
30 lines
16 KiB
HTML
<html><head><meta http-equiv="X-UA-Compatible" content="IE=edge" /><link rel="shortcut icon" href="../icons/favicon.ico" /><link rel="stylesheet" type="text/css" href="../styles/branding.css" /><link rel="stylesheet" type="text/css" href="../styles/branding-en-US.css" /><script type="text/javascript" src="../scripts/branding.js"> </script><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>SpriteDatabase.LoadObjectFromXmlFile(T) Method </title><meta name="Language" content="en-us" /><meta name="System.Keywords" content="LoadObjectFromXmlFile%3CT%3E method" /><meta name="System.Keywords" content="LoadObjectFromXmlFile(Of T) method" /><meta name="System.Keywords" content="SpriteDatabase.LoadObjectFromXmlFile%3CT%3E method" /><meta name="System.Keywords" content="SpriteDatabase.LoadObjectFromXmlFile(Of T) method" /><meta name="Microsoft.Help.F1" content="SpriteLibrary.SpriteDatabase.LoadObjectFromXmlFile``1" /><meta name="Microsoft.Help.Id" content="M:SpriteLibrary.SpriteDatabase.LoadObjectFromXmlFile``1(System.String,System.Resources.ResourceManager)" /><meta name="Description" content="Load in an XML serialized item from the specified ResourceManager. You will usually make an XML file by creating an object (as a variable) and using to serialize it and save it to a file on your desktop." /><meta name="Microsoft.Help.ContentType" content="Reference" /><meta name="BrandingAware" content="true" /><meta name="container" content="SpriteLibrary" /><meta name="file" content="dad86143-a294-4bfb-c83e-49453b03de01" /><meta name="guid" content="dad86143-a294-4bfb-c83e-49453b03de01" /><link type="text/css" rel="stylesheet" href="../styles/highlight.css" /><script type="text/javascript" src="../scripts/highlight.js"> </script><link rel="stylesheet" type="text/css" href="../styles/branding-Website.css" /><script type="text/javascript" src="../scripts/jquery-1.11.0.min.js"></script><script type="text/javascript" src="../scripts/branding-Website.js"></script><script type="text/javascript" src="../scripts/clipboard.min.js"></script></head><body onload="OnLoad('cs')"><input type="hidden" id="userDataCache" class="userDataStyle" /><div class="pageHeader" id="PageHeader">SpriteLibrary<form id="SearchForm" method="get" action="#" onsubmit="javascript:TransferToSearchPage(); return false;"><input id="SearchTextBox" type="text" maxlength="200" /><button id="SearchButton" type="submit"></button></form></div><div class="pageBody"><div class="leftNav" id="leftNav"><div id="tocNav"><div class="toclevel0" data-toclevel="0"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!" /><a data-tochassubtree="true" href="6b7227c0-7a6a-6342-3b08-917c7de429cc.htm" title="SpriteLibrary" tocid="roottoc">SpriteLibrary</a></div><div class="toclevel0" data-toclevel="0"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!" /><a data-tochassubtree="true" href="6b7227c0-7a6a-6342-3b08-917c7de429cc.htm" title="SpriteLibrary" tocid="6b7227c0-7a6a-6342-3b08-917c7de429cc">SpriteLibrary</a></div><div class="toclevel0" data-toclevel="0"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!" /><a data-tochassubtree="true" href="b2b20aab-3fc0-1b0f-8fda-213dbc180690.htm" title="SpriteDatabase Class" tocid="b2b20aab-3fc0-1b0f-8fda-213dbc180690">SpriteDatabase Class</a></div><div class="toclevel1" data-toclevel="1" data-childrenloaded="true"><a class="tocExpanded" onclick="javascript: Toggle(this);" href="#!" /><a data-tochassubtree="true" href="0ac330a3-1432-ae65-488e-e5948e7871bf.htm" title="SpriteDatabase Methods" tocid="0ac330a3-1432-ae65-488e-e5948e7871bf">SpriteDatabase Methods</a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="337078d6-e10a-94ca-0251-13a9f58ded01.htm" title="CloneByXMLSerializing(T) Method " tocid="337078d6-e10a-94ca-0251-13a9f58ded01">CloneByXMLSerializing(T) Method </a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="26d6c521-4554-21ef-3a61-402e06a3ca01.htm" title="GetImageFromName Method " tocid="26d6c521-4554-21ef-3a61-402e06a3ca01">GetImageFromName Method </a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="bbc5d326-0dc1-c076-d4dc-796ed4738814.htm" title="GetImageNames Method " tocid="bbc5d326-0dc1-c076-d4dc-796ed4738814">GetImageNames Method </a></div><div class="toclevel2 current" data-toclevel="2"><a data-tochassubtree="false" href="dad86143-a294-4bfb-c83e-49453b03de01.htm" title="LoadObjectFromXmlFile(T) Method " tocid="dad86143-a294-4bfb-c83e-49453b03de01">LoadObjectFromXmlFile(T) Method </a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="66486a11-2831-a2ee-75d8-e86857d192ab.htm" title="OpenEditWindow Method " tocid="66486a11-2831-a2ee-75d8-e86857d192ab">OpenEditWindow Method </a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="1962c085-27f4-4748-a63e-5148364328b4.htm" title="ReadFromXmlFile(T) Method " tocid="1962c085-27f4-4748-a63e-5148364328b4">ReadFromXmlFile(T) Method </a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="7ee23002-2338-41cf-0c54-def8b272bb80.htm" title="ReadFromXmlString(T) Method " tocid="7ee23002-2338-41cf-0c54-def8b272bb80">ReadFromXmlString(T) Method </a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="10c1df07-a9b0-63b4-3503-33b0fdd334c3.htm" title="Save Method " tocid="10c1df07-a9b0-63b4-3503-33b0fdd334c3">Save Method </a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="f333050a-7353-3dd6-922c-52bb94ce2f0e.htm" title="SetIcon Method " tocid="f333050a-7353-3dd6-922c-52bb94ce2f0e">SetIcon Method </a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="ac60fbfe-2f25-8d24-b1a2-6cd83762f380.htm" title="SetSnapGridSize Method " tocid="ac60fbfe-2f25-8d24-b1a2-6cd83762f380">SetSnapGridSize Method </a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="74aa367b-553a-4521-6844-a23b91ef5d58.htm" title="SpriteFromName Method " tocid="74aa367b-553a-4521-6844-a23b91ef5d58">SpriteFromName Method </a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="62400d06-17d8-96c4-90b2-d8e8198daba5.htm" title="SpriteNames Method " tocid="62400d06-17d8-96c4-90b2-d8e8198daba5">SpriteNames Method </a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="e8336b9d-8af9-22bf-8934-d6a343349847.htm" title="WriteToXmlFile(T) Method " tocid="e8336b9d-8af9-22bf-8934-d6a343349847">WriteToXmlFile(T) Method </a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="387652c9-df19-4da9-fa94-2f1002c0902f.htm" title="WriteToXMLString(T) Method " tocid="387652c9-df19-4da9-fa94-2f1002c0902f">WriteToXMLString(T) Method </a></div></div><div id="tocResizableEW" onmousedown="OnMouseDown(event);"></div><div id="TocResize" class="tocResize"><img id="ResizeImageIncrease" src="../icons/TocOpen.gif" onclick="OnIncreaseToc()" alt="Click or drag to resize" title="Click or drag to resize" /><img id="ResizeImageReset" src="../icons/TocClose.gif" style="display:none" onclick="OnResetToc()" alt="Click or drag to resize" title="Click or drag to resize" /></div></div><div class="topicContent" id="TopicContent"><table class="titleTable"><tr><td class="titleColumn"><h1>SpriteDatabase<span id="LST6558C3A0_0"></span><script type="text/javascript">AddLanguageSpecificTextSet("LST6558C3A0_0?cpp=::|nu=.");</script>LoadObjectFromXmlFile<span id="LST6558C3A0_1"></span><script type="text/javascript">AddLanguageSpecificTextSet("LST6558C3A0_1?cs=<|vb=(Of |cpp=<|fs=<'|nu=(");</script><span class="typeparameter">T</span><span id="LST6558C3A0_2"></span><script type="text/javascript">AddLanguageSpecificTextSet("LST6558C3A0_2?cs=>|vb=)|cpp=>|fs=>|nu=)");</script> Method </h1></td></tr></table><span class="introStyle"></span> <div class="summary">
|
||
Load in an XML serialized item from the specified ResourceManager. You will usually make an XML file by
|
||
creating an object (as a variable) and using <a href="e8336b9d-8af9-22bf-8934-d6a343349847.htm">WriteToXmlFile<span id="LST6558C3A0_3"></span><script type="text/javascript">AddLanguageSpecificTextSet("LST6558C3A0_3?cs=<|vb=(Of |cpp=<|fs=<'|nu=(");</script>T<span id="LST6558C3A0_4"></span><script type="text/javascript">AddLanguageSpecificTextSet("LST6558C3A0_4?cs=>|vb=)|cpp=>|fs=>|nu=)");</script>(String, T)</a> to
|
||
serialize it and save it to a file on your desktop. Then you can drag and drop that file into your project and then use this
|
||
LoadObjectFromXmlFile function. You can google XML Serialization for more information.
|
||
</div><p> </p>
|
||
<strong>Namespace:</strong>
|
||
<a href="6b7227c0-7a6a-6342-3b08-917c7de429cc.htm">SpriteLibrary</a><br />
|
||
<strong>Assembly:</strong>
|
||
SpriteLibrary (in SpriteLibrary.dll) Version: 1.0.0.6 (1.0.0.6)<div class="collapsibleAreaRegion"><span class="collapsibleRegionTitle" onclick="SectionExpandCollapse('ID1RB')" onkeypress="SectionExpandCollapse_CheckKey('ID1RB', event)" tabindex="0"><img id="ID1RBToggle" class="collapseToggle" src="../icons/SectionExpanded.png" />Syntax</span></div><div id="ID1RBSection" class="collapsibleSection"><div class="codeSnippetContainer"><div class="codeSnippetContainerTabs"><div id="ID0EACA_tab1" class="codeSnippetContainerTabSingle">C#</div></div><div class="codeSnippetContainerCodeContainer"><div class="codeSnippetToolBar"><div class="codeSnippetToolBarText"><a id="ID0EACA_copyCode" href="#" class="copyCodeSnippet" onclick="javascript:CopyToClipboard('ID0EACA');return false;" title="Copy">Copy</a></div></div><div id="ID0EACA_code_Div1" class="codeSnippetContainerCode" style="display: block"><pre xml:space="preserve"><span class="keyword">public</span> <span class="keyword">static</span> T <span class="identifier">LoadObjectFromXmlFile</span><T>(
|
||
<span class="identifier">string</span> <span class="parameter">XMLResourceToLoad</span>,
|
||
<span class="identifier">ResourceManager</span> <span class="parameter">MyManager</span>
|
||
)
|
||
<span class="keyword">where</span> T : <span class="keyword">new</span>()
|
||
</pre></div></div></div><script type="text/javascript">AddLanguageTabSet("ID0EACA");</script><h4 class="subHeading">Parameters</h4><dl><dt><span class="parameter">XMLResourceToLoad</span></dt><dd>Type: <a href="http://msdn2.microsoft.com/en-us/library/s1wwdcbf" target="_blank">System<span id="LST6558C3A0_5"></span><script type="text/javascript">AddLanguageSpecificTextSet("LST6558C3A0_5?cs=.|vb=.|cpp=::|nu=.|fs=.");</script>String</a><br />The resource item to load. If you would access it like: properties.resources.myFile,
|
||
the correct value to put here would be "myFile"</dd><dt><span class="parameter">MyManager</span></dt><dd>Type: <a href="http://msdn2.microsoft.com/en-us/library/2xsy4hac" target="_blank">System.Resources<span id="LST6558C3A0_6"></span><script type="text/javascript">AddLanguageSpecificTextSet("LST6558C3A0_6?cs=.|vb=.|cpp=::|nu=.|fs=.");</script>ResourceManager</a><br />The resource manager. Usually Properties.Resources.ResourceManager</dd></dl><h4 class="subHeading">Type Parameters</h4><dl><dt><span class="parameter">T</span></dt><dd>The type of object to load. It could be something as simple as an int, a class, or a list of classes.</dd></dl><h4 class="subHeading">Return Value</h4>Type: <span class="selflink"><span class="typeparameter">T</span></span><br />An object of the value you specified. Or null if it fails.</div><div class="collapsibleAreaRegion"><span class="collapsibleRegionTitle" onclick="SectionExpandCollapse('ID2RB')" onkeypress="SectionExpandCollapse_CheckKey('ID2RB', event)" tabindex="0"><img id="ID2RBToggle" class="collapseToggle" src="../icons/SectionExpanded.png" />Examples</span></div><div id="ID2RBSection" class="collapsibleSection">
|
||
XML Serialization takes an object (a class, a variable, or whatever) and will store any public values in XML.
|
||
You can choose to save the resulting XML as a string, or to save it to a file. This function Loads it from a
|
||
resource file (one which has been added to Properties.Resources.) The corresponding write function:
|
||
<a href="e8336b9d-8af9-22bf-8934-d6a343349847.htm">WriteToXmlFile<span id="LST6558C3A0_7"></span><script type="text/javascript">AddLanguageSpecificTextSet("LST6558C3A0_7?cs=<|vb=(Of |cpp=<|fs=<'|nu=(");</script>T<span id="LST6558C3A0_8"></span><script type="text/javascript">AddLanguageSpecificTextSet("LST6558C3A0_8?cs=>|vb=)|cpp=>|fs=>|nu=)");</script>(String, T)</a> writes to a file that is outside of Properties.Resources; the
|
||
resources of a program are read-only. Once you write to a file, you can drag the resulting XML into your project
|
||
and load it from there. If you want to load from an XML file that is not a resource, use <a href="1962c085-27f4-4748-a63e-5148364328b4.htm">ReadFromXmlFile<span id="LST6558C3A0_9"></span><script type="text/javascript">AddLanguageSpecificTextSet("LST6558C3A0_9?cs=<|vb=(Of |cpp=<|fs=<'|nu=(");</script>T<span id="LST6558C3A0_10"></span><script type="text/javascript">AddLanguageSpecificTextSet("LST6558C3A0_10?cs=>|vb=)|cpp=>|fs=>|nu=)");</script>(String)</a><p />Here is code to create an item and save it to a file.
|
||
<div class="codeSnippetContainer"><div class="codeSnippetContainerCodeContainer"><div class="codeSnippetToolBar"><div class="codeSnippetToolBarText"><a id="ID0EACEBA_copyCode" href="#" class="copyCodeSnippet" onclick="javascript:CopyToClipboard('ID0EACEBA');return false;" title="Copy">Copy</a></div></div><div id="ID0EACEBA_code_Div1" class="codeSnippetContainerCode" style="display: block"><pre xml:space="preserve">MyClass MyVariable = <span class="highlight-keyword">new</span> MyClass();
|
||
MyVariable.Name = <span class="highlight-literal">"StoreThis!"</span>;
|
||
|
||
SpriteDatabase.WriteToXmlFile<MyClass>(<span class="highlight-literal">"c:\xml_file.xml"</span>, MyClass);</pre></div></div></div><script type="text/javascript">AddLanguageTabSet("ID0EACEBA");</script>
|
||
Now that we have an XML file, we drag that file into our project so that it shows up in our Properties.Resources
|
||
and then we can use this code to load it.
|
||
<div class="codeSnippetContainer"><div class="codeSnippetContainerCodeContainer"><div class="codeSnippetToolBar"><div class="codeSnippetToolBarText"><a id="ID0EAAEBA_copyCode" href="#" class="copyCodeSnippet" onclick="javascript:CopyToClipboard('ID0EAAEBA');return false;" title="Copy">Copy</a></div></div><div id="ID0EAAEBA_code_Div1" class="codeSnippetContainerCode" style="display: block"><pre xml:space="preserve">MyClass MyVariable = SpriteDatabase.LoadObjectFromXmlFile<MyClass>(<span class="highlight-literal">"xml_file"</span>,Properties.Resources.ResourceManager);
|
||
Console.WriteLine(MyVariable.Name);</pre></div></div></div><script type="text/javascript">AddLanguageTabSet("ID0EAAEBA");</script></div><div class="collapsibleAreaRegion" id="seeAlsoSection"><span class="collapsibleRegionTitle" onclick="SectionExpandCollapse('ID3RB')" onkeypress="SectionExpandCollapse_CheckKey('ID3RB', event)" tabindex="0"><img id="ID3RBToggle" class="collapseToggle" src="../icons/SectionExpanded.png" />See Also</span></div><div id="ID3RBSection" class="collapsibleSection"><h4 class="subHeading">Reference</h4><div class="seeAlsoStyle"><a href="b2b20aab-3fc0-1b0f-8fda-213dbc180690.htm">SpriteDatabase Class</a></div><div class="seeAlsoStyle"><a href="6b7227c0-7a6a-6342-3b08-917c7de429cc.htm">SpriteLibrary Namespace</a></div></div></div></div><div id="pageFooter" class="pageFooter"> </div></body></html> |