-
-
Notifications
You must be signed in to change notification settings - Fork 33
Expand file tree
/
Copy pathWestwind.RazorHosting.xml
More file actions
1356 lines (1314 loc) · 65.1 KB
/
Westwind.RazorHosting.xml
File metadata and controls
1356 lines (1314 loc) · 65.1 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?xml version="1.0"?>
<doc>
<assembly>
<name>Westwind.RazorHosting</name>
</assembly>
<members>
<member name="T:Westwind.RazorHosting.AnonymousDynamicType">
<summary>
This class handles special non-public types - anonymous types
and allows returning property values from them.
Requires Reflection permissions for internal,private properties
</summary>
</member>
<member name="F:Westwind.RazorHosting.AnonymousDynamicType.Instance">
<summary>
Internally stored instance on which to look up properties
via Reflection
</summary>
</member>
<member name="M:Westwind.RazorHosting.AnonymousDynamicType.#ctor(System.Object)">
<summary>
Require passing in off an instance
</summary>
<param name="instance"></param>
</member>
<member name="T:Westwind.RazorHosting.HelperResult">
<summary>
Helped class used by Razor to render generated code.
</summary>
</member>
<member name="M:Westwind.RazorHosting.HelperResult.#ctor(System.Action{System.IO.TextWriter})">
<summary>
Initializes a new instance of the <see cref="T:Westwind.RazorHosting.HelperResult"/> class,
with the provided <paramref name="action"/>.
</summary>
<param name="action">The action that should be used to produce the result.</param>
</member>
<member name="M:Westwind.RazorHosting.HelperResult.ToHtmlString">
<summary>
Returns a HTML formatted <see cref="T:System.String"/> that represents the current <see cref="T:Westwind.RazorHosting.HelperResult"/>.
</summary>
<returns>A HTML formatted <see cref="T:System.String"/> that represents the current <see cref="T:Westwind.RazorHosting.HelperResult"/>.</returns>
</member>
<member name="M:Westwind.RazorHosting.HelperResult.ToString">
<summary>
Returns a <see cref="T:System.String"/> that represents the current <see cref="T:Westwind.RazorHosting.HelperResult"/>.
</summary>
<returns>A <see cref="T:System.String"/> that represents the current <see cref="T:Westwind.RazorHosting.HelperResult"/>.</returns>
</member>
<member name="M:Westwind.RazorHosting.HelperResult.WriteTo(System.IO.TextWriter)">
<summary>
Writes the output of the <see cref="T:Westwind.RazorHosting.HelperResult"/> to the provided <paramref name="writer"/>.
</summary>
<param name="writer">A <see cref="T:System.IO.TextWriter"/> instance that the output should be written to.</param>
</member>
<member name="M:Westwind.RazorHosting.HelperResult.WriteTo(System.IO.TextWriter,System.Object)">
<summary>
Writes the output of the <see cref="T:Westwind.RazorHosting.HelperResult"/> to the provided <paramref name="writer"/>.
</summary>
<param name="writer">A <see cref="T:System.IO.TextWriter"/> instance that the output should be written to.</param>
<param name="val"></param>
</member>
<member name="M:Westwind.RazorHosting.IHtmlString.ToHtmlString">
<summary>
Returns an HTML-encoded string.
</summary>
<returns>An HTML-encoded string.</returns>
</member>
<member name="T:Westwind.RazorHosting.RawString">
<summary>
Class that wraps a string and returns it as a raw
non-encoded string.
</summary>
</member>
<member name="P:Westwind.RazorHosting.RawString.Empty">
<summary>
</summary>
</member>
<member name="T:Westwind.RazorHosting.RazorEngine">
<summary>
Razor Hosting Engine that allows execution of Razor templates outside of
ASP.NET. You can execute templates from string or a textreader and output
to string or a text reader.
This implementation only supports C#.
</summary>
</member>
<member name="T:Westwind.RazorHosting.RazorEngine`1">
<summary>
Razor Hosting Engine that allows execution of Razor templates outside of
ASP.NET. You can execute templates from string or a textreader and output
to string or a text reader.
This implementation only supports C#.
</summary>
<typeparam name="TBaseTemplateType">RazorTemplateHost based type</typeparam>
</member>
<member name="P:Westwind.RazorHosting.RazorEngine`1.ErrorMessage">
<summary>
Any errors that occurred during template execution
</summary>
</member>
<member name="P:Westwind.RazorHosting.RazorEngine`1.LastGeneratedCode">
<summary>
Last generated output
</summary>
</member>
<member name="P:Westwind.RazorHosting.RazorEngine`1.LastResultData">
<summary>
Allows retrieval of the template's ResultData property
to be retrieved from the last request.
</summary>
</member>
<member name="P:Westwind.RazorHosting.RazorEngine`1.Configuration">
<summary>
Holds Razor Configuration Properties
</summary>
</member>
<member name="P:Westwind.RazorHosting.RazorEngine`1.HostContainer">
<summary>
Provide a reference to a RazorHost container so that it
can be passed to a template.
This may be null, but if a container is available this value
is set and passed on to the template as HostContainer.
</summary>
</member>
<member name="P:Westwind.RazorHosting.RazorEngine`1.CodeProvider">
<summary>
The code provider used with this instance
</summary>
</member>
<member name="P:Westwind.RazorHosting.RazorEngine`1.ReferencedNamespaces">
<summary>
A list of default namespaces to include
Defaults already included:
System, System.Text, System.IO, System.Collections.Generic, System.Linq
</summary>
</member>
<member name="P:Westwind.RazorHosting.RazorEngine`1.ReferencedAssemblies">
<summary>
A list of default assemblies referenced during compilation
Defaults already included:
System, System.Text, System.IO, System.Collections.Generic, System.Linq
</summary>
</member>
<member name="P:Westwind.RazorHosting.RazorEngine`1.AssemblyCache">
<summary>
Internally cache assemblies loaded with ParseAndCompileTemplate.
Assemblies are cached in the EngineHost so they don't have
to cross AppDomains for invocation when running in a separate AppDomain
</summary>
</member>
<member name="P:Westwind.RazorHosting.RazorEngine`1.TemplatePerRequestConfigurationData">
<summary>
A property that holds any per request configuration
data that is to be passed to the template. This object
is passed to InitializeTemplate after the instance was
created.
This object must be serializable.
This object should be set on every request and cleared out after
each request
</summary>
</member>
<member name="M:Westwind.RazorHosting.RazorEngine`1.#ctor(Microsoft.CSharp.CSharpCodeProvider)">
<summary>
Creates an instance of the host and performs basic configuration
Optionally pass in any required namespaces and assemblies by name
</summary>
</member>
<member name="M:Westwind.RazorHosting.RazorEngine`1.AddAssembly(System.String,System.String[])">
<summary>
Method to add assemblies to the referenced assembly list.
Use the DLL name or strongly typed name. Assembly added HAS
to be accessible via GAC or in bin/privatebin path
</summary>
<param name="assemblyPath">
Path to the assembly. GAC'd assemblies or assemblies in current path
can be provided without a path. All others should contain a fully qualified OS path.
Note that Razor does not look in the PrivateBin path for the AppDomain.
</param>
<param name="additionalAssemblies">Additional assembly paths to add </param>
</member>
<member name="M:Westwind.RazorHosting.RazorEngine`1.AddAssemblyFromType(System.Type)">
<summary>
Adds an assembly to the Referenced assemblies based on a type
reference. Useful to add the 'host' assembly and model types.
</summary>
<param name="type"></param>
</member>
<member name="M:Westwind.RazorHosting.RazorEngine`1.AddAssemblyFromType(System.Object)">
<summary>
Adds an assembly to the ReferenceAssemblies based on an object instance.
Easy way to add a model's assembly.
</summary>
<param name="instance">any object instance</param>
</member>
<member name="M:Westwind.RazorHosting.RazorEngine`1.AddNamespace(System.String,System.String[])">
<summary>
Method to add namespaces to the compiled code.
Add namespaces to minimize explicit namespace
requirements in your Razor template code.
Make sure that any required assemblies are
loaded first.
</summary>
<param name="ns">First namespace</param>
<param name="additionalNamespaces">additional namespaces</param>
</member>
<member name="M:Westwind.RazorHosting.RazorEngine`1.AddNamespace(System.String[])">
<summary>
Method to add namespaces to the compiled code.
Add namespaces to minimize explicit namespace
requirements in your Razor template code.
Make sure that any required assemblies are
loaded first.
</summary>
<param name="additionalNamespaces">additional namespaces</param>
</member>
<member name="M:Westwind.RazorHosting.RazorEngine`1.RenderTemplate(System.IO.TextReader,System.Object,System.IO.TextWriter)">
<summary>
Execute a template based on a TextReader input into a provided TextWriter object.
</summary>
<param name="templateSourceReader">A text reader that reads in the markup template</param>
<param name="model">Optional model available in the template as this.Context</param>
<param name="outputWriter">
A text writer that receives the rendered template output.
Writer is closed after rendering.
When provided the result of this method is string.Empty (success) or null (failure)
</param>
<returns>output from template. If an outputWriter is passed in result is string.Empty on success, null on failure</returns>
</member>
<member name="M:Westwind.RazorHosting.RazorEngine`1.RenderTemplate(System.String,System.Object,System.IO.TextWriter,System.Boolean)">
<summary>
Execute a template based on a TextReader input into a provided TextWriter object.
</summary>
<param name="templateText">A string that contains the markup template</param>
<param name="model">Optional model available in the template as this.Context</param>
<param name="outputWriter">
A text writer that receives the rendered template output.
Writer is closed after rendering.
When provided the result of this method is string.Empty (success) or null (failure)
</param>
<param name="inferModelType">If true, tries to infer the model type when no @model or @inherits tags are defined for the template</param>
<returns>output from template. If an outputWriter is passed in result is string.Empty on success, null on failure</returns>
</member>
<member name="M:Westwind.RazorHosting.RazorEngine`1.RenderTemplateFromAssembly(System.String,System.Object,System.IO.TextWriter,System.String,System.String)">
<summary>
Executes a template based on a previously compiled and cached assembly reference.
This effectively allows you to cache an assembly.
</summary>
<param name="assemblyId">Id of an existing assembly that was previously compiled</param>
<param name="model">The model to use</param>
<param name="outputWriter">A text writer that receives output generated by the template. Writer is closed after rendering.</param>
<param name="generatedNamespace"></param>
<param name="generatedClass"></param>
<returns>output from template. If an outputWriter is passed in result is string.Empty on success, null on failure</returns>
</member>
<member name="M:Westwind.RazorHosting.RazorEngine`1.CompileTemplate(System.IO.TextReader,System.String,System.String)">
<summary>
Parses and compiles a markup template into an assembly and returns
an assembly name. The name is an ID that can be passed to
ExecuteTemplateByAssembly which picks up a cached instance of the
loaded assembly.
</summary>
<param name="templateReader">Textreader that loads the template</param>
<param name="generatedNamespace">The namespace of the class to generate from the template. null generates name.</param>
<param name="generatedClassName">The name of the class to generate from the template. null generates name.</param>
<remarks>
The actual assembly isn't returned here to allow for cross-AppDomain
operation. If the assembly was returned it would fail for cross-AppDomain
calls.
</remarks>
<returns>An assembly Id. The Assembly is cached in memory and can be used with RenderFromAssembly.</returns>
</member>
<member name="M:Westwind.RazorHosting.RazorEngine`1.CompileTemplate(System.String,System.String,System.String)">
<summary>
Parses and compiles a markup template into an assembly and returns
an assembly name. The name is an ID that can be passed to
ExecuteTemplateByAssembly which picks up a cached instance of the
loaded assembly.
</summary>
<param name="templateText">Text of the template to render</param>
<param name="generatedNamespace">Namespace for the generated class. If not passed will be __RazorHosting</param>
<param name="generatedClassName">Classname for the generated class. If not passed will be a generated unique name based on GUID</param>
<remarks>
The actual assembly isn't returned here to allow for cross-AppDomain
operation. If the assembly was returned it would fail for cross-AppDomain
calls.
</remarks>
<returns>An assembly Id. The Assembly is cached in memory and can be used with RenderFromAssembly.</returns>
</member>
<member name="M:Westwind.RazorHosting.RazorEngine`1.CreateHost(System.String,System.String,System.Type)">
<summary>
Creates an instance of the RazorHost with various options applied.
Applies basic namespace imports and the name of the class to generate
</summary>
<param name="generatedNamespace"></param>
<param name="generatedClass"></param>
<param name="baseClassType"></param>
<returns></returns>
</member>
<member name="M:Westwind.RazorHosting.RazorEngine`1.GetAssemblyFromId(System.String)">
<summary>
Allows retrieval of an Assembly cached internally by its id
returned from ParseAndCompileTemplate. Useful if you want
to write an assembly to disk for later activation
</summary>
<param name="assemblyId"></param>
</member>
<member name="M:Westwind.RazorHosting.RazorEngine`1.InstantiateTemplateClass(System.Type)">
<summary>
Overridable instance creation routine for the host.
Handle custom template base classes (derived from RazorTemplateBase)
and setting of properties on the instance in subclasses by overriding
this method.
</summary>
<param name="type"></param>
<returns></returns>
</member>
<member name="M:Westwind.RazorHosting.RazorEngine`1.InvokeTemplateInstance(`0,System.Object)">
<summary>
Internally executes an instance of the template,
captures errors on execution and returns true or false
</summary>
<param name="instance">An instance of the generated template</param>
<param name="model"></param>
<returns>true or false - check ErrorMessage for errors</returns>
</member>
<member name="M:Westwind.RazorHosting.RazorEngine`1.InitializeLifetimeService">
<summary>
Override to allow indefinite lifetime - no unloading
</summary>
<returns></returns>
</member>
<member name="M:Westwind.RazorHosting.RazorEngine`1.FixupTemplate(System.String)">
<summary>
Internally fix ups for templates
</summary>
<param name="template"></param>
<returns></returns>
</member>
<member name="M:Westwind.RazorHosting.RazorEngine`1.GetSafeClassName(System.Object)">
<summary>
Returns a unique ClassName for a template to execute
Optionally pass in an objectId on which the code is based
or null to get default behavior.
Default implementation just returns Guid as string
</summary>
<param name="objectId"></param>
<returns></returns>
</member>
<member name="M:Westwind.RazorHosting.RazorEngine`1.SetError(System.String)">
<summary>
Sets error information consistently
</summary>
<param name="message"></param>
</member>
<member name="T:Westwind.RazorHosting.RazorEngineConfiguration">
<summary>
Configuration for the Host class. These settings determine some of the
operational parameters of the RazorHost class that can be changed at
runtime.
</summary>
</member>
<member name="P:Westwind.RazorHosting.RazorEngineConfiguration.CompileToMemory">
<summary>
Determines if assemblies are compiled to disk or to memory.
If compiling to disk generated assemblies are not cleaned up
</summary>
</member>
<member name="P:Westwind.RazorHosting.RazorEngineConfiguration.TempAssemblyPath">
<summary>
When compiling to disk use this Path to hold generated assemblies
</summary>
</member>
<member name="P:Westwind.RazorHosting.RazorEngineConfiguration.OutputEncoding">
<summary>
Encoding to be used when generating output to file
</summary>
</member>
<member name="P:Westwind.RazorHosting.RazorEngineConfiguration.StreamBufferSize">
<summary>
Buffer size for streamed template output when using filenames
</summary>
</member>
<member name="P:Westwind.RazorHosting.RazorEngineConfiguration.TempFiles">
<summary>
Specifies %Temp% folder for compiled files
</summary>
</member>
<member name="T:Westwind.RazorHosting.RazorEngineFactory`1">
<summary>
Factory that creates a RazorHost instance in a remote
AppDomain that can be unloaded. This allows unloading of
assemblies created through scripting.
Both static and instance loader methods are available. For
AppDomain created hosts.
Note:
Only works for a single AppDomain as this class holds on
to the AppDomain as a Singleton.
</summary>
<typeparam name="TBaseTemplateType">RazorTemplateBase based type</typeparam>
</member>
<member name="F:Westwind.RazorHosting.RazorEngineFactory`1.LocalAppDomain">
<summary>
Internal instance of the AppDomain to hang onto when
running in a separate AppDomain. Ensures the AppDomain
stays alive.
</summary>
</member>
<member name="F:Westwind.RazorHosting.RazorEngineFactory`1.Current">
<summary>
Internally managed instance of the HostFactory
that ensures that the AppDomain stays alive and
that it can be unloaded manually using the static
methods.
</summary>
</member>
<member name="M:Westwind.RazorHosting.RazorEngineFactory`1.CreateRazorHost(Microsoft.CSharp.CSharpCodeProvider)">
<summary>
Create an instance of the RazorHost in the current
AppDomain. No special handling...
</summary>
<returns></returns>
</member>
<member name="M:Westwind.RazorHosting.RazorEngineFactory`1.CreateRazorHostInAppDomain">
<summary>
Creates an instance of the RazorHost in a new AppDomain. This
version creates a static singleton that that is cached and you
can call UnloadRazorHostInAppDomain to unload it.
</summary>
<returns></returns>
</member>
<member name="M:Westwind.RazorHosting.RazorEngineFactory`1.UnloadRazorHostInAppDomain">
<summary>
Unloads the Razor host if running in a separate appdomain by
unloading the AppDomain.
</summary>
</member>
<member name="M:Westwind.RazorHosting.RazorEngineFactory`1.GetRazorHost(Microsoft.CSharp.CSharpCodeProvider)">
<summary>
Create a new instance of Razor Host in the current AppDomain.
</summary>
<param name="codeProvider"></param>
<returns></returns>
</member>
<member name="M:Westwind.RazorHosting.RazorEngineFactory`1.GetRazorHostInAppDomain">
<summary>
Instance method that creates a RazorHost in a new AppDomain.
This method requires that you keep the Factory around in
order to keep the AppDomain alive and be able to unload it.
</summary>
<returns></returns>
</member>
<member name="M:Westwind.RazorHosting.RazorEngineFactory`1.CreateAppDomain(System.String)">
<summary>
Internally creates a new AppDomain in which Razor templates can
be run.
</summary>
<param name="appDomainName"></param>
<returns></returns>
</member>
<member name="M:Westwind.RazorHosting.RazorEngineFactory`1.CurrentDomain_AssemblyResolve(System.Object,System.ResolveEventArgs)">
<summary>
Allow for custom assembly resolution to local file paths for signed dependency
assemblies.
</summary>
<param name="sender"></param>
<param name="args"></param>
<returns></returns>
</member>
<member name="M:Westwind.RazorHosting.RazorEngineFactory`1.UnloadHost">
<summary>
Allow unloading of the created AppDomain to release resources
All internal resources in the AppDomain are released including
in memory compiled Razor assemblies.
</summary>
</member>
<member name="T:Westwind.RazorHosting.Utilities">
<summary>
Helper class that provides a few simple utilitity functions to the project
</summary>
</member>
<member name="M:Westwind.RazorHosting.Utilities.GetRelativePath(System.String,System.String)">
<summary>
Returns a relative path based on a base path.
Examples:
<<ul>>
<<li>> filename.txt
<<li>> subDir\filename.txt
<<li>> ..\filename.txt
<<li>> ..\..\filename.txt
<</ul>>
<seealso>Class Utilities</seealso>
</summary>
<param name="fullPath">
The full path from which to generate a relative path
</param>
<param name="basePath">
The base path based on which the relative path is based on
</param>
<returns>string</returns>
</member>
<member name="M:Westwind.RazorHosting.Utilities.HtmlEncode(System.String)">
<summary>
HTML-encodes a string and returns the encoded string.
</summary>
<param name="text">The text string to encode. </param>
<returns>The HTML-encoded text.</returns>
</member>
<member name="M:Westwind.RazorHosting.Utilities.HtmlEncode(System.Object)">
<summary>
HtmlEncodes any value by calling ToString() first
</summary>
<param name="value"></param>
<returns></returns>
</member>
<member name="M:Westwind.RazorHosting.Utilities.GetLines(System.String,System.Int32)">
<summary>
Parses a string into an array of lines broken
by \r\n or \n
</summary>
<param name="s">String to check for lines</param>
<param name="maxLines">Optional - max number of lines to return</param>
<returns>array of strings, or null if the string passed was a null</returns>
</member>
<member name="M:Westwind.RazorHosting.Utilities.GetTextWithLineNumbers(System.String,System.String)">
<summary>
Returns the text with a prefix of line numbers
</summary>
<param name="text"></param>
<param name="lineFormat">Line format used to create the line. 0 is the line number, 1 is the text.</param>
<returns></returns>
</member>
<member name="T:Westwind.RazorHosting.RazorBaseHostContainer`1">
<summary>
Based Host implementation for hosting the RazorEngine. This base
acts as a host wrapper for implementing high level host services around
the RazorEngine class.
Provides the ability to run in a separate AppDomain and to cache
and store generated assemblies to avoid constant parsing and recompilation.
For example implementations can provide assembly
template caching so assemblies don't recompile for each access.
</summary>
<typeparam name="TBaseTemplateType">The RazorTemplateBase class that templates will be based on</typeparam>
</member>
<member name="P:Westwind.RazorHosting.RazorBaseHostContainer`1.UseAppDomain">
<summary>
Determines whether the Container hosts Razor
in a separate AppDomain. Seperate AppDomain
hosting allows unloading and releasing of
resources.
</summary>
</member>
<member name="P:Westwind.RazorHosting.RazorBaseHostContainer`1.CodeProvider">
<summary>
Optionally provide a CSharpCodeProvider code
Default uses System.CSharp.CSharpCodeProvider
</summary>
</member>
<member name="P:Westwind.RazorHosting.RazorBaseHostContainer`1.BaseBinaryFolder">
<summary>
Base folder location where the AppDomain
is hosted. By default uses the same folder
as the host application.
Determines where binary dependencies are
found for assembly references.
</summary>
</member>
<member name="P:Westwind.RazorHosting.RazorBaseHostContainer`1.ReferencedAssemblies">
<summary>
List of referenced assemblies as string values.
Must be in GAC or in the current folder of the host app/
base BinaryFolder
</summary>
</member>
<member name="P:Westwind.RazorHosting.RazorBaseHostContainer`1.ReferencedNamespaces">
<summary>
List of additional namespaces to add to all templates.
By default:
System, System.Text, System.IO, System.Linq
</summary>
</member>
<member name="P:Westwind.RazorHosting.RazorBaseHostContainer`1.GeneratedNamespace">
<summary>
Name of the generated namespace for template classes
</summary>
</member>
<member name="P:Westwind.RazorHosting.RazorBaseHostContainer`1.ErrorMessage">
<summary>
Any error messages
</summary>
</member>
<member name="P:Westwind.RazorHosting.RazorBaseHostContainer`1.LastException">
<summary>
An error object that contains additional information about the current request
</summary>
</member>
<member name="P:Westwind.RazorHosting.RazorBaseHostContainer`1.ThrowExceptions">
<summary>
Determines whether errors throw exceptions or
return error status messages.
By default exceptions are not fired and the error is instead
captured and returned in the ErrorMessage and LastException properties.
</summary>
</member>
<member name="F:Westwind.RazorHosting.RazorBaseHostContainer`1.Engine">
<summary>
Cached instance of the Host. Required to keep the
reference to the host alive for multiple uses.
</summary>
</member>
<member name="F:Westwind.RazorHosting.RazorBaseHostContainer`1.LoadedAssemblies">
<summary>
Keep track of each compiled assembly
and when it was compiled.
Use a hash of the string to identify string
changes.
</summary>
</member>
<member name="P:Westwind.RazorHosting.RazorBaseHostContainer`1.Configuration">
<summary>
Engine Configuration
</summary>
</member>
<member name="M:Westwind.RazorHosting.RazorBaseHostContainer`1.Start">
<summary>
Call to start the Host running. Follow by a calls to RenderTemplate to
render individual templates. Call Stop when done.
</summary>
<returns>true or false - check ErrorMessage on false </returns>
</member>
<member name="M:Westwind.RazorHosting.RazorBaseHostContainer`1.Stop">
<summary>
Stops the Host and releases the host AppDomain and cached
assemblies.
</summary>
<returns>true or false</returns>
</member>
<member name="M:Westwind.RazorHosting.RazorBaseHostContainer`1.RenderTemplate(System.IO.TextReader,System.Object,System.IO.TextWriter)">
<summary>
Stock implementation of RenderTemplate that doesn't allow for
any sort of assembly caching. Instead it creates and re-renders
templates read from the reader each time.
Custom implementations of RenderTemplate should be created that
allow for caching by examing a filename or string hash to determine
whether a template needs to be re-generated and compiled before
rendering.
</summary>
<param name="reader">TextReader that points at the template to compile</param>
<param name="model">Optional model data to pass to template</param>
<param name="writer">TextReader passed in that receives output</param>
<returns></returns>
</member>
<member name="M:Westwind.RazorHosting.RazorBaseHostContainer`1.RenderTemplateFromAssembly(System.String,System.Object,System.IO.TextWriter)">
<summary>
Renders a template based on a previously compiled assembly reference. This method allows for
caching assemblies by their assembly Id.
</summary>
<param name="assemblyId">Id of a previously compiled assembly</param>
<param name="model">Optional model data object</param>
<param name="writer">Output writer</param>
<returns></returns>
</member>
<member name="M:Westwind.RazorHosting.RazorBaseHostContainer`1.RenderHtmlErrorPage(System.Boolean)">
<summary>
Renders an unformatted self contained error page that can be displayed in the
the browser.
</summary>
<param name="noTemplateSourceCode"></param>
<returns></returns>
</member>
<member name="M:Westwind.RazorHosting.RazorBaseHostContainer`1.GetSafeClassName(System.Object)">
<summary>
Returns a unique ClassName for a template to execute
Optionally pass in an objectId on which the code is based
or null to get default behavior.
Default implementation just returns Guid as string
</summary>
<param name="objectId"></param>
<returns></returns>
</member>
<member name="M:Westwind.RazorHosting.RazorBaseHostContainer`1.AddAssemblyFromType(System.Type)">
<summary>
Adds an assembly to the referenced assemblies from an existing
.NET Type.
</summary>
<param name="instance"></param>
</member>
<member name="M:Westwind.RazorHosting.RazorBaseHostContainer`1.AddAssemblyFromType(System.Object)">
<summary>
Adds an assembly to the referenced assemblies from an existing
object instance.
</summary>
<param name="instance"></param>
</member>
<member name="M:Westwind.RazorHosting.RazorBaseHostContainer`1.InitializeLifetimeService">
<summary>
Force this host to stay alive indefinitely
</summary>
<returns></returns>
</member>
<member name="M:Westwind.RazorHosting.RazorBaseHostContainer`1.SetError(System.String)">
<summary>
Sets an error message consistently
</summary>
<param name="message"></param>
</member>
<member name="M:Westwind.RazorHosting.RazorBaseHostContainer`1.SetErrorException(Westwind.RazorHosting.RazorHostContainerException)">
<summary>
Sets the LastException of the host from an existing
RazorHostContainer exception
</summary>
<param name="ex"></param>
</member>
<member name="M:Westwind.RazorHosting.RazorBaseHostContainer`1.SetError">
<summary>
Sets an error message consistently
</summary>
</member>
<member name="M:Westwind.RazorHosting.RazorBaseHostContainer`1.Dispose">
<summary>
Automatically stops the host
</summary>
</member>
<member name="T:Westwind.RazorHosting.RazorFolderHostContainer">
<summary>
This class is a caching directory based host wrapper around
the RazorHost classes to provide directory based Razor
template execution. Templates are compiled on
the fly, and cached unless the templates on disk are changed.
Runs Razor Templates in a seperate AppDomain
Uses the RazorTemplateFolderHost base template by default.
For any other template implementation use the generic parameter
to specify the template type.
</summary>
</member>
<member name="T:Westwind.RazorHosting.RazorFolderHostContainer`1">
<summary>
This class is a caching directory based host wrapper around
the RazorHost classes to provide directory based Razor
template execution. Templates are compiled on
the fly, and cached unless the templates on disk are changed.
Runs Razor Templates in a seperate AppDomain
</summary>
<typeparam name="TBaseTemplate">The type of the base template to use</typeparam>
</member>
<member name="P:Westwind.RazorHosting.RazorFolderHostContainer`1.TemplatePath">
<summary>
The Path where templates live
</summary>
</member>
<member name="P:Westwind.RazorHosting.RazorFolderHostContainer`1.RenderingOutputFile">
<summary>
When rendering to a file render output to this
file.
</summary>
</member>
<member name="M:Westwind.RazorHosting.RazorFolderHostContainer`1.RenderTemplate(System.String,System.Object,System.IO.TextWriter,System.Boolean)">
<summary>
Renders a template to a TextWriter. Useful to write output into a stream or
the Response object. Used for partial rendering.
</summary>
<param name="relativePath">Relative path to the file in the folder structure</param>
<param name="model">Optional parameter that is set as the Model property in generic versions</param>
<param name="writer">The textwriter to write output into</param>
<param name="isLayoutPage"></param>
<returns></returns>
</member>
<member name="M:Westwind.RazorHosting.RazorFolderHostContainer`1.RenderHtmlErrorPage(System.Boolean)">
<summary>
Renders an HTML
</summary>
<param name="noTemplateSourceCode"></param>
<returns></returns>
</member>
<member name="M:Westwind.RazorHosting.RazorFolderHostContainer`1.GetAssemblyFromFileAndCache(System.String)">
<summary>
Internally checks if a cached assembly exists and if it does uses it
else creates and compiles one. Returns an assembly Id to be
used with the LoadedAssembly list.
</summary>
<param name="relativePath"></param>
<returns></returns>
</member>
<member name="M:Westwind.RazorHosting.RazorFolderHostContainer`1.HasFileChanged(System.String,System.DateTime)">
<summary>
Determine if a file has been changed since a known date.
Dates are specified in UTC format.
</summary>
<param name="relativePath">relative path to the template root.</param>
<param name="originalTimeUtc"></param>
<returns></returns>
</member>
<member name="M:Westwind.RazorHosting.RazorFolderHostContainer`1.GetSafeClassName(System.Object)">
<summary>
Overridden to return a unique name based on the filename
</summary>
<param name="objectId">Filename</param>
<returns></returns>
</member>
<member name="T:Westwind.RazorHosting.CompiledAssemblyItem">
<summary>
Item that stores information about a cached assembly
that keeps track of templates that have been compiled
and cached.
</summary>
</member>
<member name="T:Westwind.RazorHosting.RazorHostContainerException">
<summary>
LastException thrown when rendering or compiling of a folder host
render or initialization occurs
</summary>
</member>
<member name="P:Westwind.RazorHosting.RazorHostContainerException.GeneratedSourceCode">
<summary>
Source code for the template if available
</summary>
</member>
<member name="P:Westwind.RazorHosting.RazorHostContainerException.ActiveTemplate">
<summary>
The active template that is being rendered when
rendering file templates
</summary>
</member>
<member name="P:Westwind.RazorHosting.RazorHostContainerException.RequestConfigurationData">
<summary>
Template Engine Configuration Data
</summary>
</member>
<member name="P:Westwind.RazorHosting.RazorHostContainerException.CallStack">
<summary>
Call stack when an actual exception occurred - not always available
</summary>
</member>
<member name="T:Westwind.RazorHosting.RazorStringHostContainer">
<summary>
Razor Host container to execute Razor Templates from string input.
Can run templates in a separate AppDomain and caches templates
to avoid re-compilation and allocation of new resources for
each template.
</summary>
</member>
<member name="T:Westwind.RazorHosting.RazorStringHostContainer`1">
<summary>
Razor Host container to execute Razor Templates from string input.
Can run templates in a separate AppDomain and caches templates
to avoid re-compilation and allocation of new resources for
each template.
</summary>
</member>
<member name="M:Westwind.RazorHosting.RazorStringHostContainer`1.RenderTemplate(System.String,System.Object,System.IO.TextWriter,System.Boolean)">
<summary>
Call this method to actually render a template to the specified outputfile
</summary>"
<param name="templateText">The template text to parse and render</param>
<param name="model">
Any object that will be available in the template as a dynamic of this.Context or
if the type matches the template type this.Model.
</param>
<param name="writer">Optional textwriter that output is written to</param>
<param name="inferModelType">If true infers the model type if no @model or @inherits tag is provided</param>
<returns>rendering results or null on failure. If a writer is a passed string.Empty is returned or null for failure</returns>
</member>
<member name="M:Westwind.RazorHosting.RazorStringHostContainer`1.RenderTemplateToFile(System.String,System.Object,System.String,System.Boolean)">
<summary>
Renders a template from a string input to a file output.
Same text templates are compiled and cached for re-use.
</summary>
<param name="templateText">Text of the template to run</param>
<param name="model">Optional model to pass</param>
<param name="outputFile">Output file where output is sent to</param>
<param name="inferModelType">If true infers the model type if no @model or @inherits tag is provided</param>
<returns></returns>
</member>
<member name="M:Westwind.RazorHosting.RazorStringHostContainer`1.GetAssemblyFromStringAndCache(System.String)">
<summary>
Internally tries to retrieve a previously compiled template from cache
if not found compiles a template into an assembly
always returns an assembly id as a string.
</summary>
<param name="templateText">The text to parse</param>
<returns>assembly id as a string or null on error</returns>
</member>
<member name="T:Westwind.RazorHosting.RazorTemplateConfiguration">
<summary>
Configuration objects that can be passed to templates to pass additional
information down to the templates from a Host container
</summary>
</member>
<member name="P:Westwind.RazorHosting.RazorTemplateConfiguration.ModelData">
<summary>
Use this object to pass configuration data to the template
</summary>
</member>
<member name="T:Westwind.RazorHosting.RazorFolderHostTemplateConfiguration">
<summary>
Folder Host specific configuration object
</summary>
</member>
<member name="T:Westwind.RazorHosting.Properties.Resources">
<summary>
A strongly-typed resource class, for looking up localized strings, etc.
</summary>
</member>
<member name="P:Westwind.RazorHosting.Properties.Resources.ResourceManager">
<summary>
Returns the cached ResourceManager instance used by this class.
</summary>
</member>
<member name="P:Westwind.RazorHosting.Properties.Resources.Culture">
<summary>
Overrides the current thread's CurrentUICulture property for all
resource lookups using this strongly typed resource class.
</summary>
</member>
<member name="P:Westwind.RazorHosting.Properties.Resources.CouldnTActivateTypeInstance">
<summary>
Looks up a localized string similar to Couldn't activate compiled template type instance: .
</summary>
</member>
<member name="P:Westwind.RazorHosting.Properties.Resources.ErrorReadingTemplateFile">
<summary>
Looks up a localized string similar to Error reading template file: .
</summary>
</member>
<member name="P:Westwind.RazorHosting.Properties.Resources.LineX0TColX1TErrorX2RN">
<summary>
Looks up a localized string similar to Line: {0}\t Col: {1}\t Error: {2}
.
</summary>
</member>
<member name="P:Westwind.RazorHosting.Properties.Resources.PartialRenderingFailed">
<summary>
Looks up a localized string similar to Partial Rendering failed for {0}: {1}.
</summary>
</member>
<member name="P:Westwind.RazorHosting.Properties.Resources.PreviouslyCompiledAssemblyNotFound">
<summary>
Looks up a localized string similar to Previously compiled assembly not found..
</summary>
</member>
<member name="P:Westwind.RazorHosting.Properties.Resources.TemplateExecutionError">
<summary>
Looks up a localized string similar to Template Execution Error: .
</summary>
</member>
<member name="P:Westwind.RazorHosting.Properties.Resources.TemplateFileDoesnTExist">
<summary>
Looks up a localized string similar to Template File doesn't exist: .
</summary>
</member>
<member name="P:Westwind.RazorHosting.Properties.Resources.UnableToCreateType">
<summary>
Looks up a localized string similar to Unable to create type .
</summary>
</member>
<member name="P:Westwind.RazorHosting.Properties.Resources.UnableToLoadRazorEngine">
<summary>
Looks up a localized string similar to Unable to load Razor Engine.
</summary>
</member>
<member name="M:Westwind.RazorHosting.HtmlHelper.Raw(System.String)">
<summary>
Output a string without formatting
</summary>
<param name="html"></param>
<returns></returns>
</member>
<member name="M:Westwind.RazorHosting.HtmlHelper.HtmlString(System.Object)">
<summary>