Skip to content

Commit 0764014

Browse files
authored
Add localized customNodeModel sample (#38)
* fix build * update appveyor build add new sample node add new spanish resx add new copy steps for localized content
1 parent da4333a commit 0764014

File tree

8 files changed

+189
-5
lines changed

8 files changed

+189
-5
lines changed

appveyor.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,10 @@ platform: Any CPU
55
configuration: Release
66

77
build:
8-
project: src/DynamoSamples.2013.sln
8+
project: src/DynamoSamples.sln
99
verbosity: normal
1010

1111
test: off
1212

1313
before_build:
14-
- nuget restore .\src\DynamoSamples.2013.sln
14+
- nuget restore .\src\DynamoSamples.sln

src/SampleExtension/Extension.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ public string UniqueId
3535
{
3636
get
3737
{
38-
"49fee64a-4505-4f03-a6b6-0667a793f19a"
38+
return "49fee64a-4505-4f03-a6b6-0667a793f19a";
3939
}
4040
}
4141

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
using Dynamo.Graph.Nodes;
2+
using Newtonsoft.Json;
3+
using ProtoCore.AST.AssociativeAST;
4+
using System;
5+
using System.Collections.Generic;
6+
using System.Linq;
7+
using System.Text;
8+
using System.Threading.Tasks;
9+
10+
namespace SampleLibraryUI.Examples
11+
{
12+
/// <summary>
13+
/// This example node uses .net .resx files and generated sattelite assemblies to perform runtime lookup of localized content
14+
/// depending on the culture of the system Dynamo is running on.
15+
/// Read more: https://docs.microsoft.com/en-us/dotnet/framework/resources/creating-resource-files-for-desktop-apps
16+
/// You can use the -l "es-ES" flag when starting DynamoSandbox.exe to replace the English strings with Spanish ones.
17+
/// </summary>
18+
[NodeName("LocalizedNode")]
19+
[NodeDescription("CustomNodeModelDescription", typeof(Properties.Resources))]
20+
[OutPortNames("string")]
21+
[OutPortTypes("string")]
22+
[IsDesignScriptCompatible]
23+
public class LocalizedCustomNodeModel : NodeModel
24+
{
25+
public LocalizedCustomNodeModel()
26+
{
27+
RegisterAllPorts();
28+
}
29+
30+
[JsonConstructor]
31+
public LocalizedCustomNodeModel(IEnumerable<PortModel> inPorts, IEnumerable<PortModel> outPorts) : base(inPorts, outPorts) { }
32+
33+
public override IEnumerable<AssociativeNode> BuildOutputAst(List<AssociativeNode> inputAstNodes)
34+
{
35+
//return a localized string, that is defined in the resx file/resource assembly.
36+
return new List<AssociativeNode> { AstFactory.BuildAssignment(this.AstIdentifierForPreview, AstFactory.BuildPrimitiveNodeFromObject(Properties.Resources.LocalStringResult)) };
37+
}
38+
}
39+
}

src/SampleLibraryUI/Properties/Resources.Designer.cs

Lines changed: 9 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

src/SampleLibraryUI/Properties/Resources.en-US.resx

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -127,4 +127,7 @@
127127
<data name="CustomNodeModePortDataOutputToolTip" xml:space="preserve">
128128
<value>A result.</value>
129129
</data>
130+
<data name="LocalStringResult" xml:space="preserve">
131+
<value>I am a localized string.</value>
132+
</data>
130133
</root>
Lines changed: 126 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,126 @@
1+
<?xml version="1.0" encoding="utf-8"?>
2+
<root>
3+
<!--
4+
Microsoft ResX Schema
5+
6+
Version 2.0
7+
8+
The primary goals of this format is to allow a simple XML format
9+
that is mostly human readable. The generation and parsing of the
10+
various data types are done through the TypeConverter classes
11+
associated with the data types.
12+
13+
Example:
14+
15+
... ado.net/XML headers & schema ...
16+
<resheader name="resmimetype">text/microsoft-resx</resheader>
17+
<resheader name="version">2.0</resheader>
18+
<resheader name="reader">System.Resources.ResXResourceReader, System.Windows.Forms, ...</resheader>
19+
<resheader name="writer">System.Resources.ResXResourceWriter, System.Windows.Forms, ...</resheader>
20+
<data name="Name1"><value>this is my long string</value><comment>this is a comment</comment></data>
21+
<data name="Color1" type="System.Drawing.Color, System.Drawing">Blue</data>
22+
<data name="Bitmap1" mimetype="application/x-microsoft.net.object.binary.base64">
23+
<value>[base64 mime encoded serialized .NET Framework object]</value>
24+
</data>
25+
<data name="Icon1" type="System.Drawing.Icon, System.Drawing" mimetype="application/x-microsoft.net.object.bytearray.base64">
26+
<value>[base64 mime encoded string representing a byte array form of the .NET Framework object]</value>
27+
<comment>This is a comment</comment>
28+
</data>
29+
30+
There are any number of "resheader" rows that contain simple
31+
name/value pairs.
32+
33+
Each data row contains a name, and value. The row also contains a
34+
type or mimetype. Type corresponds to a .NET class that support
35+
text/value conversion through the TypeConverter architecture.
36+
Classes that don't support this are serialized and stored with the
37+
mimetype set.
38+
39+
The mimetype is used for serialized objects, and tells the
40+
ResXResourceReader how to depersist the object. This is currently not
41+
extensible. For a given mimetype the value must be set accordingly:
42+
43+
Note - application/x-microsoft.net.object.binary.base64 is the format
44+
that the ResXResourceWriter will generate, however the reader can
45+
read any of the formats listed below.
46+
47+
mimetype: application/x-microsoft.net.object.binary.base64
48+
value : The object must be serialized with
49+
: System.Runtime.Serialization.Formatters.Binary.BinaryFormatter
50+
: and then encoded with base64 encoding.
51+
52+
mimetype: application/x-microsoft.net.object.soap.base64
53+
value : The object must be serialized with
54+
: System.Runtime.Serialization.Formatters.Soap.SoapFormatter
55+
: and then encoded with base64 encoding.
56+
57+
mimetype: application/x-microsoft.net.object.bytearray.base64
58+
value : The object must be serialized into a byte array
59+
: using a System.ComponentModel.TypeConverter
60+
: and then encoded with base64 encoding.
61+
-->
62+
<xsd:schema id="root" xmlns="" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:msdata="urn:schemas-microsoft-com:xml-msdata">
63+
<xsd:import namespace="http://www.w3.org/XML/1998/namespace" />
64+
<xsd:element name="root" msdata:IsDataSet="true">
65+
<xsd:complexType>
66+
<xsd:choice maxOccurs="unbounded">
67+
<xsd:element name="metadata">
68+
<xsd:complexType>
69+
<xsd:sequence>
70+
<xsd:element name="value" type="xsd:string" minOccurs="0" />
71+
</xsd:sequence>
72+
<xsd:attribute name="name" use="required" type="xsd:string" />
73+
<xsd:attribute name="type" type="xsd:string" />
74+
<xsd:attribute name="mimetype" type="xsd:string" />
75+
<xsd:attribute ref="xml:space" />
76+
</xsd:complexType>
77+
</xsd:element>
78+
<xsd:element name="assembly">
79+
<xsd:complexType>
80+
<xsd:attribute name="alias" type="xsd:string" />
81+
<xsd:attribute name="name" type="xsd:string" />
82+
</xsd:complexType>
83+
</xsd:element>
84+
<xsd:element name="data">
85+
<xsd:complexType>
86+
<xsd:sequence>
87+
<xsd:element name="value" type="xsd:string" minOccurs="0" msdata:Ordinal="1" />
88+
<xsd:element name="comment" type="xsd:string" minOccurs="0" msdata:Ordinal="2" />
89+
</xsd:sequence>
90+
<xsd:attribute name="name" type="xsd:string" use="required" msdata:Ordinal="1" />
91+
<xsd:attribute name="type" type="xsd:string" msdata:Ordinal="3" />
92+
<xsd:attribute name="mimetype" type="xsd:string" msdata:Ordinal="4" />
93+
<xsd:attribute ref="xml:space" />
94+
</xsd:complexType>
95+
</xsd:element>
96+
<xsd:element name="resheader">
97+
<xsd:complexType>
98+
<xsd:sequence>
99+
<xsd:element name="value" type="xsd:string" minOccurs="0" msdata:Ordinal="1" />
100+
</xsd:sequence>
101+
<xsd:attribute name="name" type="xsd:string" use="required" />
102+
</xsd:complexType>
103+
</xsd:element>
104+
</xsd:choice>
105+
</xsd:complexType>
106+
</xsd:element>
107+
</xsd:schema>
108+
<resheader name="resmimetype">
109+
<value>text/microsoft-resx</value>
110+
</resheader>
111+
<resheader name="version">
112+
<value>2.0</value>
113+
</resheader>
114+
<resheader name="reader">
115+
<value>System.Resources.ResXResourceReader, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</value>
116+
</resheader>
117+
<resheader name="writer">
118+
<value>System.Resources.ResXResourceWriter, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</value>
119+
</resheader>
120+
<data name="CustomNodeModelDescription" xml:space="preserve">
121+
<value>Un nodo de interfaz de usuario de muestra que muestra una interfaz de usuario personalizada.</value>
122+
</data>
123+
<data name="LocalStringResult" xml:space="preserve">
124+
<value>Soy una cadena localizada.</value>
125+
</data>
126+
</root>

src/SampleLibraryUI/Properties/Resources.resx

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -127,4 +127,7 @@
127127
<data name="CustomNodeModelPortDataOutputToolTip" xml:space="preserve">
128128
<value>A result.</value>
129129
</data>
130+
<data name="LocalStringResult" xml:space="preserve">
131+
<value>I am a localized string.</value>
132+
</data>
130133
</root>

src/SampleLibraryUI/SampleLibraryUI.csproj

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -151,6 +151,7 @@
151151
</Compile>
152152
<Compile Include="Examples\ButtonCustomNodeModel.cs" />
153153
<Compile Include="Examples\DropDown.cs" />
154+
<Compile Include="Examples\LocalizedCustomNodeModel.cs" />
154155
<Compile Include="Properties\AssemblyInfo.cs" />
155156
<Compile Include="Examples\SliderCustomNodeModel.cs" />
156157
<Compile Include="Properties\Resources.Designer.cs">
@@ -175,6 +176,7 @@
175176
</Page>
176177
</ItemGroup>
177178
<ItemGroup>
179+
<EmbeddedResource Include="Properties\Resources.es-ES.resx" />
178180
<EmbeddedResource Include="Properties\Resources.resx">
179181
<Generator>ResXFileCodeGenerator</Generator>
180182
<LastGenOutput>Resources.Designer.cs</LastGenOutput>
@@ -209,9 +211,11 @@
209211
<Target Name="AfterBuild">
210212
<ItemGroup>
211213
<PackageFiles Include="$(OutDir)\SampleLibraryUI.dll;$(OutDir)\SampleLibraryUI.XML;$(OutDir)\SampleLibraryUI.dll.config" />
212-
<ResourceFiles Include="$(OutDir)\en-US\*.*" />
214+
<ENResourceFiles Include="$(OutDir)\en-US\*.*" />
215+
<ESResourceFiles Include="$(OutDir)\es-ES\*.*" />
213216
</ItemGroup>
214217
<Copy SourceFiles="@(PackageFiles)" DestinationFolder="$(SolutionDir)..\dynamo_package\Dynamo Samples\bin\" />
215-
<Copy SourceFiles="@(ResourceFiles)" DestinationFolder="$(SolutionDir)..\dynamo_package\Dynamo Samples\bin\en-US" />
218+
<Copy SourceFiles="@(ENResourceFiles)" DestinationFolder="$(SolutionDir)..\dynamo_package\Dynamo Samples\bin\en-US" />
219+
<Copy SourceFiles="@(ESResourceFiles)" DestinationFolder="$(SolutionDir)..\dynamo_package\Dynamo Samples\bin\es-ES" />
216220
</Target>
217221
</Project>

0 commit comments

Comments
 (0)