-
Notifications
You must be signed in to change notification settings - Fork 2
/
ImageResizer.XML
4986 lines (4970 loc) · 256 KB
/
ImageResizer.XML
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>ImageResizer</name>
</assembly>
<members>
<member name="T:ImageResizer.BoxEdges">
<summary>
Represents the widths of edges of a box.
</summary>
</member>
<member name="M:ImageResizer.BoxEdges.#ctor(System.Double)">
<summary>
Create a box with all edges the same width.
</summary>
<param name="all"></param>
</member>
<member name="M:ImageResizer.BoxEdges.#ctor(System.Double,System.Double,System.Double,System.Double)">
<summary>
Create a box, specifying individual widths for each size
</summary>
<param name="left"></param>
<param name="top"></param>
<param name="right"></param>
<param name="bottom"></param>
</member>
<member name="M:ImageResizer.BoxEdges.#ctor(ImageResizer.BoxEdges)">
<summary>
Copies the specified BoxEdges instance
</summary>
<param name="original"></param>
</member>
<member name="M:ImageResizer.BoxEdges.SetAll(System.Double)">
<summary>
Sets the width of all edges, returning a new instance
</summary>
<param name="all"></param>
<returns></returns>
</member>
<member name="M:ImageResizer.BoxEdges.GetEdgeOffsets">
<summary>
Gets edge offsets as a clockwise array, starting with Top.
</summary>
<returns></returns>
</member>
<member name="P:ImageResizer.BoxEdges.All">
<summary>
Returns double.NaN unless all edges are the same width, in which case that width is returned
</summary>
</member>
<member name="P:ImageResizer.BoxEdges.Empty">
<summary>
Returns an instance with a width of 0
</summary>
</member>
<member name="P:ImageResizer.BoxEdges.IsEmpty">
<summary>
Returns true if th
</summary>
</member>
<member name="M:ImageResizer.Collections.QuerystringBase`1.Get``1(System.String)">
<summary>
Provides culture-invariant parsing of byte, int, double, float, bool, and enum values.
</summary>
<typeparam name="T"></typeparam>
<param name="name"></param>
<returns></returns>
</member>
<member name="M:ImageResizer.Collections.QuerystringBase`1.Get``1(System.String,System.Nullable{``0})">
<summary>
Provides culture-invariant parsing of byte, int, double, float, bool, and enum values.
</summary>
<typeparam name="T"></typeparam>
<param name="name"></param>
<param name="defaultValue"></param>
<returns></returns>
</member>
<member name="M:ImageResizer.Collections.QuerystringBase`1.Get``1(System.String,``0)">
<summary>
Provides culture-invariant parsing of byte, int, double, float, bool, and enum values.
</summary>
<typeparam name="T"></typeparam>
<param name="name"></param>
<param name="defaultValue"></param>
<returns></returns>
</member>
<member name="M:ImageResizer.Collections.QuerystringBase`1.SetAsString``1(System.String,``0)">
<summary>
Serializes the given value by calling .ToString(). If the value is null, the key is removed.
</summary>
<typeparam name="T"></typeparam>
<param name="name"></param>
<param name="val"></param>
<returns></returns>
</member>
<member name="M:ImageResizer.Collections.QuerystringBase`1.Set``1(System.String,System.Nullable{``0})">
<summary>
Provides culture-invariant serialization of value types, in lower case for querystring readability. Setting a key to null removes it.
</summary>
<typeparam name="T"></typeparam>
<param name="q"></param>
<param name="name"></param>
<param name="val"></param>
<returns></returns>
</member>
<member name="M:ImageResizer.Configuration.Logging.ILogger.Log(System.String,System.String)">
<summary>
Writes the diagnostic message at the specified level.
</summary>
<param name="level">The log level.</param>
<param name="message">A <see langword="string" /> to be written.</param>
</member>
<member name="M:ImageResizer.Configuration.Logging.ILogger.Trace(System.String)">
<summary>
Writes the diagnostic message at the Trace level.
</summary>
<param name="message">A <see langword="string" /> to be written.</param>
</member>
<member name="M:ImageResizer.Configuration.Logging.ILogger.Debug(System.String)">
<summary>
Writes the diagnostic message at the Debug level.
</summary>
<param name="message">A <see langword="string" /> to be written.</param>
</member>
<member name="M:ImageResizer.Configuration.Logging.ILogger.Info(System.String)">
<summary>
Writes the diagnostic message at the Info level.
</summary>
<param name="message">A <see langword="string" /> to be written.</param>
</member>
<member name="M:ImageResizer.Configuration.Logging.ILogger.Warn(System.String)">
<summary>
Writes the diagnostic message at the Warn level.
</summary>
<param name="message">A <see langword="string" /> to be written.</param>
</member>
<member name="M:ImageResizer.Configuration.Logging.ILogger.Error(System.String)">
<summary>
Writes the diagnostic message at the Error level.
</summary>
<param name="message">A <see langword="string" /> to be written.</param>
</member>
<member name="M:ImageResizer.Configuration.Logging.ILogger.Fatal(System.String)">
<summary>
Writes the diagnostic message at the Fatal level.
</summary>
<param name="message">A <see langword="string" /> to be written.</param>
</member>
<member name="M:ImageResizer.Configuration.Logging.ILogger.IsEnabled(System.String)">
<summary>
Checks if the specified log level is enabled.
</summary>
<param name="level">The log level.</param>
<returns>A value indicating whether the specified log level is enabled.</returns>
</member>
<member name="P:ImageResizer.Configuration.Logging.ILogger.IsTraceEnabled">
<summary>
Gets a value indicating whether the Trace level is enabled.
</summary>
</member>
<member name="P:ImageResizer.Configuration.Logging.ILogger.IsDebugEnabled">
<summary>
Gets a value indicating whether the Debug level is enabled.
</summary>
</member>
<member name="P:ImageResizer.Configuration.Logging.ILogger.IsInfoEnabled">
<summary>
Gets a value indicating whether the Info level is enabled.
</summary>
</member>
<member name="P:ImageResizer.Configuration.Logging.ILogger.IsWarnEnabled">
<summary>
Gets a value indicating whether the Warn level is enabled.
</summary>
</member>
<member name="P:ImageResizer.Configuration.Logging.ILogger.IsErrorEnabled">
<summary>
Gets a value indicating whether the Error level is enabled.
</summary>
</member>
<member name="P:ImageResizer.Configuration.Logging.ILogger.IsFatalEnabled">
<summary>
Gets a value indicating whether the Fatal level is enabled.
</summary>
</member>
<member name="P:ImageResizer.Configuration.Logging.ILogger.LoggerName">
<summary>
Gets or sets the logger name.
</summary>
</member>
<member name="M:ImageResizer.Configuration.Logging.ILogManager.LoadConfigFromFile(System.String)">
<summary>
Loads NLog configuration from the specified file.
</summary>
<param name="fileName">The name of the file to load NLog configuration from.</param>
</member>
<member name="M:ImageResizer.Configuration.Logging.ILogManager.GetLogger(System.String)">
<summary>
Creates the specified logger object and assigns a LoggerName to it.
</summary>
<param name="loggerName">Logger name.</param>
<returns>The new logger instance.</returns>
</member>
<member name="T:ImageResizer.Configuration.Plugins.NativeDependencyManager">
<summary>
Provides automatic download of native dependencies (which VS doesn't see). Gets the correct bitness as well - very nice if you're changing app pool bitness and forgot to change binaries.
</summary>
</member>
<member name="M:ImageResizer.Configuration.Issues.IssueSink.GetIssues">
<summary>
Returns a copy of the list of reported issues.
</summary>
<returns></returns>
</member>
<member name="M:ImageResizer.Configuration.Issues.IssueSink.AcceptIssue(ImageResizer.Configuration.Issues.IIssue)">
<summary>
Adds the specified issue to the list unless it is an exact duplicate of another instance.
</summary>
<param name="i"></param>
</member>
<member name="T:ImageResizer.Configuration.Plugins.NativeDependencyManager.Countdown">
<summary>
Thread safe countdown class
</summary>
</member>
<member name="T:ImageResizer.ExtensionMethods.EnumExtensions">
<summary>
Extends enumerations by allowing them to define alternate strings with the [EnumString("Alternate Name",true)] attribute, and support it through TryParse and ToPreferredString
</summary>
</member>
<member name="M:ImageResizer.ExtensionMethods.EnumExtensions.Parse``1(``0,System.String,``0)">
<summary>
Attempts case-insensitive parsing of the specified enum. Returns the specified default value if parsing fails.
Supports [EnumString("Alternate Value")] attributes and parses flags. If any segment of a comma-delimited list isn't parsed as either a number or string, defaultValue will be returned.
</summary>
<param name="en"></param>
<param name="value"></param>
<returns></returns>
</member>
<member name="M:ImageResizer.ExtensionMethods.EnumExtensions.Parse``1(``0,System.String)">
<summary>
Attempts case-insensitive parsing of the specified enum. Returns null if parsing failed.
Supports [EnumString("Alternate Value")] attributes and parses flags. If any segment of a comma-delimited list isn't parsed as either a number or string, null will be returned.
</summary>
<param name="en"></param>
<param name="value"></param>
<returns></returns>
</member>
<member name="M:ImageResizer.ExtensionMethods.EnumExtensions.ToPreferredString(System.Enum,System.Boolean)">
<summary>
Retuns the string representation for the given enumeration
</summary>
<param name="en"></param>
<param name="lowerCase"></param>
<returns></returns>
</member>
<member name="M:ImageResizer.ExtensionMethods.NameValueCollectionExtensions.Get``1(System.Collections.Specialized.NameValueCollection,System.String)">
<summary>
Provides culture-invariant parsing of int, double, float, bool, and enum values.
</summary>
<typeparam name="T"></typeparam>
<param name="t"></param>
<param name="name"></param>
<returns></returns>
</member>
<member name="M:ImageResizer.ExtensionMethods.NameValueCollectionExtensions.Get``1(System.Collections.Specialized.NameValueCollection,System.String,System.Nullable{``0})">
<summary>
Provides culture-invariant parsing of int, double, float, bool, and enum values.
</summary>
<typeparam name="T"></typeparam>
<param name="q"></param>
<param name="name"></param>
<param name="defaultValue"></param>
<returns></returns>
</member>
<member name="M:ImageResizer.ExtensionMethods.NameValueCollectionExtensions.Get``1(System.Collections.Specialized.NameValueCollection,System.String,``0)">
<summary>
Provides culture-invariant parsing of int, double, float, bool, and enum values.
</summary>
<typeparam name="T"></typeparam>
<param name="q"></param>
<param name="name"></param>
<param name="defaultValue"></param>
<returns></returns>
</member>
<member name="M:ImageResizer.ExtensionMethods.NameValueCollectionExtensions.ParsePrimitive``1(System.String,System.Nullable{``0})">
<summary>
Provides culture-invariant parsing of int, double, float, bool, and enum values.
</summary>
<typeparam name="T"></typeparam>
<param name="value"></param>
<param name="defaultValue"></param>
<returns></returns>
</member>
<member name="M:ImageResizer.ExtensionMethods.NameValueCollectionExtensions.SetAsString``1(System.Collections.Specialized.NameValueCollection,System.String,``0)">
<summary>
Serializes the given value by calling .ToString(). If the value is null, the key is removed.
</summary>
<typeparam name="T"></typeparam>
<param name="q"></param>
<param name="name"></param>
<param name="val"></param>
<returns></returns>
</member>
<member name="M:ImageResizer.ExtensionMethods.NameValueCollectionExtensions.Set``1(System.Collections.Specialized.NameValueCollection,System.String,System.Nullable{``0})">
<summary>
Provides culture-invariant serialization of value types, in lower case for querystring readability. Setting a key to null removes it.
</summary>
<typeparam name="T"></typeparam>
<param name="q"></param>
<param name="name"></param>
<param name="val"></param>
<returns></returns>
</member>
<member name="M:ImageResizer.ExtensionMethods.NameValueCollectionExtensions.ParseList``1(System.String,System.Nullable{``0},System.Int32[])">
<summary>
Parses a comma-delimited list of primitive values. If there are unparsable items in the list, they will be replaced with 'fallbackValue'. If fallbackValue is null, the function will return null
</summary>
<typeparam name="T"></typeparam>
<param name="text"></param>
<param name="fallbackValue"></param>
<param name="allowedSizes"></param>
<returns></returns>
</member>
<member name="M:ImageResizer.ExtensionMethods.NameValueCollectionExtensions.IsOneSpecified(System.Collections.Specialized.NameValueCollection,System.String[])">
<summary>
Returns true if any of the specified keys contain a value
</summary>
<param name="q"></param>
<param name="keys"></param>
<returns></returns>
</member>
<member name="M:ImageResizer.ExtensionMethods.NameValueCollectionExtensions.Normalize(System.Collections.Specialized.NameValueCollection,System.String,System.String)">
<summary>
Normalizes a command that has two possible names.
If either of the commands has a null or empty value, those keys are removed.
If both the the primary and secondary are present, the secondary is removed.
Otherwise, the secondary is renamed to the primary name.
</summary>
<param name="primary"></param>
<param name="secondary"></param>
</member>
<member name="M:ImageResizer.ExtensionMethods.NameValueCollectionExtensions.Keep(System.Collections.Specialized.NameValueCollection,System.String[])">
<summary>
Creates and returns a new NameValueCollection instance that contains only the specified keys from the current collection.
</summary>
<param name="q"></param>
<param name="keysToKeep"></param>
<returns></returns>
</member>
<member name="M:ImageResizer.ExtensionMethods.NameValueCollectionExtensions.MergeDefaults(System.Collections.Specialized.NameValueCollection,System.Collections.Specialized.NameValueCollection)">
<summary>
Creates and returns a new NameValueCollection instance that contains all of the
keys/values from 'q', and any keys/values from 'defaults' that 'q' does not already
contain.
</summary>
<param name="q">The settings specific to a particular query</param>
<param name="defaults">Default settings to use when not overridden by 'q'.</param>
<returns></returns>
</member>
<member name="T:ImageResizer.ExtensionMethods.StreamExtensions">
<summary>
Provides extension methods for copying streams
</summary>
</member>
<member name="M:ImageResizer.ExtensionMethods.StreamExtensions.CopyToMemoryStream(System.IO.Stream)">
<summary>
Copies the remaining data in the current stream to a new MemoryStream instance.
</summary>
<param name="s"></param>
<returns></returns>
</member>
<member name="M:ImageResizer.ExtensionMethods.StreamExtensions.CopyToMemoryStream(System.IO.Stream,System.Boolean)">
<summary>
Copies the current stream into a new MemoryStream instance.
</summary>
<param name="s"></param>
<param name="entireStream">True to copy entire stream if seeakable, false to only copy remaining data</param>
<returns></returns>
</member>
<member name="M:ImageResizer.ExtensionMethods.StreamExtensions.CopyToMemoryStream(System.IO.Stream,System.Boolean,System.Int32)">
<summary>
Copies the current stream into a new MemoryStream instance.
</summary>
<param name="s"></param>
<param name="entireStream">True to copy entire stream if seeakable, false to only copy remaining data</param>
<param name="chunkSize">The buffer size to use (in bytes) if a buffer is required. Default: 4KiB</param>
<returns></returns>
</member>
<member name="M:ImageResizer.ExtensionMethods.StreamExtensions.CopyToBytes(System.IO.Stream)">
<summary>
Copies the remaining data in the current stream to a byte[] array of exact size.
</summary>
<param name="s"></param>
<returns></returns>
</member>
<member name="M:ImageResizer.ExtensionMethods.StreamExtensions.CopyToBytes(System.IO.Stream,System.Boolean)">
<summary>
Copies the current stream into a byte[] array of exact size.
</summary>
<param name="s"></param>
<param name="entireStream">True to copy entire stream if seeakable, false to only copy remaining data</param>
<returns></returns>
</member>
<member name="M:ImageResizer.ExtensionMethods.StreamExtensions.CopyToStream(System.IO.Stream,System.IO.Stream)">
<summary>
Copies the remaining data from the this stream into the given stream.
</summary>
<param name="s"></param>
<param name="other">The stream to write to</param>
</member>
<member name="M:ImageResizer.ExtensionMethods.StreamExtensions.CopyToStream(System.IO.Stream,System.IO.Stream,System.Boolean)">
<summary>
Copies this stream into the given stream
</summary>
<param name="s"></param>
<param name="other">The stream to write to</param>
<param name="entireStream">True to copy entire stream if seeakable, false to only copy remaining data</param>
</member>
<member name="M:ImageResizer.ExtensionMethods.StreamExtensions.CopyToStream(System.IO.Stream,System.IO.Stream,System.Boolean,System.Int32)">
<summary>
Copies this stream into the given stream
</summary>
<param name="src"></param>
<param name="dest">The stream to write to</param>
<param name="entireStream">True to copy entire stream if seeakable, false to only copy remaining data</param>
<param name="chunkSize">True to copy entire stream if seeakable, false to only copy remaining data</param>
</member>
<member name="M:ImageResizer.ExtensionMethods.StreamExtensions.CopyToBytes(System.IO.Stream,System.Boolean,System.Int32)">
<summary>
Copies the current stream into a byte[] array of exact size
</summary>
<param name="src"></param>
<param name="entireStream">True to copy entire stream if seeakable, false to only copy remaining data.</param>
<param name="chunkSize">The buffer size to use (in bytes) if a buffer is required. Default: 4KiB</param>
<returns></returns>
</member>
<member name="M:ImageResizer.ExtensionMethods.StreamExtensions.CopyOrReturnBuffer(System.IO.Stream,System.Int64@,System.Boolean,System.Int32)">
<summary>
Attempts to return a byte[] array containing the remaining portion of the stream.
Unlike CopyToBytes(), does not return a byte[] array of exact length, and may re-use the actual Stream's byte array, making it unsafe to write to in the future.
</summary>
<param name="src"></param>
<param name="length"></param>
<param name="chunkSize"></param>
<returns></returns>
</member>
<member name="M:ImageResizer.ImageJob.#ctor(System.Object,System.Collections.Generic.IEnumerable{System.String})">
<summary>
Creates an ImageJob that won't run a full build - it will only do enough work in order to supply the requested data fields.
</summary>
<param name="source"></param>
<param name="requestedImageInfo">Pass null to use "source.width","source.height", "result.ext","result.mime". </param>
</member>
<member name="M:ImageResizer.ImageJob.Build">
<summary>
Shorthand method for ImageBuilder.Current.Build(this)
</summary>
<returns></returns>
</member>
<member name="M:ImageResizer.ImageJob.CreateDir">
<summary>
Sets CreateParentDirectory to true. Provided for easy chaining so you can do one-liners.
new ImageJob(source,dest,settings).CreateDir().Build()
</summary>
<returns></returns>
</member>
<member name="M:ImageResizer.ImageJob.ResolveTemplatedPath(System.String,ImageResizer.Util.PathUtils.VariableResolverCallback)">
<summary>
Internal use only.
Resolves the specified (potenetially templated) path into a physical path.
Applies the AddFileExtension setting using the 'ext' variable.
Supplies the guid, settings.*, filename, path, and originalExt variables.
The resolver method should supply 'ext', 'width', and 'height' (all of which refer to the final image).
If AllowDestinationPathVariables=False, only AddFileExtenson will be processed.
</summary>
<param name="path"></param>
<param name="resolver"></param>
<returns></returns>
</member>
<member name="P:ImageResizer.ImageJob.RequestedInfo">
<summary>
A list of strings which define properties that can be returned to the caller. "source.width", "source.height", "result.ext", "result.mime" are the most commonly used. Defaults to none
</summary>
</member>
<member name="P:ImageResizer.ImageJob.ResultInfo">
<summary>
A dictionary of key/value pairs provided along with the result.
</summary>
</member>
<member name="P:ImageResizer.ImageJob.Source">
<summary>
The source image's physical path, app-relative virtual path, or a Stream, byte array, Bitmap, VirtualFile, IVirtualFile, HttpPostedFile, or HttpPostedFileBase instance.
</summary>
</member>
<member name="P:ImageResizer.ImageJob.Dest">
<summary>
The destination Stream, physical path, or app-relative virtual path. If a Bitmap instance is desired,
set this to typeof(System.Drawing.Bitmap). The result will be stored in .Result
</summary>
</member>
<member name="P:ImageResizer.ImageJob.Result">
<summary>
The result if a Bitmap, BitmapSource, or IWICBitmapSource instance is requested.
</summary>
</member>
<member name="P:ImageResizer.ImageJob.SourceWidth">
<summary>
The width, in pixels, of the first frame or page in the source image file
</summary>
</member>
<member name="P:ImageResizer.ImageJob.SourceHeight">
<summary>
The height, in pixels, of the first frame or page in the source image file
</summary>
</member>
<member name="P:ImageResizer.ImageJob.ResultFileExtension">
<summary>
The correct file extension for the resulting file stream, without a leading dot. Will be null if the result is not an encoded image.
</summary>
</member>
<member name="P:ImageResizer.ImageJob.ResultMimeType">
<summary>
The correct mime type for the resulting file stream, without a leading dot. Will be null if the result is not an encoded image.
</summary>
</member>
<member name="P:ImageResizer.ImageJob.Settings">
<summary>
The image processing settings
</summary>
</member>
<member name="P:ImageResizer.ImageJob.Instructions">
<summary>
The image processing instructions
</summary>
</member>
<member name="P:ImageResizer.ImageJob.DisposeSourceObject">
<summary>
If true, and if 'source' is a IDisposable instead like Bitmap or Stream instance, it will be disposed after it has been used. Defaults to true.
</summary>
</member>
<member name="P:ImageResizer.ImageJob.ResetSourceStream">
<summary>
If true, and if 'source' is seekable, the stream will be reset to its previous position after being read.
Always true for HttpPostedFile(Base) instances, defaults to false for all others.
</summary>
</member>
<member name="P:ImageResizer.ImageJob.DisposeDestinationStream">
<summary>
If true, and if 'dest' is a Stream instance, it will be disposed after the image has been written. Defaults to false.
</summary>
</member>
<member name="P:ImageResizer.ImageJob.FinalPath">
<summary>
Contains the final physical path to the image (if 'dest' was a path - null otherwise)
</summary>
</member>
<member name="P:ImageResizer.ImageJob.SourcePathData">
<summary>
If 'source' contains any path-related data, it is copied into this member for use by format detetction code, so decoding can be optimized.
May be a physical or virtual path, or just a file name.
</summary>
</member>
<member name="P:ImageResizer.ImageJob.AddFileExtension">
<summary>
If true, the appropriate extension for the encoding format will be added to the destination path, and the result will be stored in FinalPath in physical path form.
</summary>
</member>
<member name="P:ImageResizer.ImageJob.AllowDestinationPathVariables">
<summary>
If true (the default), destination paths can include variables that are expanded during the image build process.
Ex. Dest = "~/folder/<guid>.<ext>" will expand to "C:\WWW\App\folder\1ddadaadaddaa75da75ad34ad33da3a.jpg".
</summary>
</member>
<member name="P:ImageResizer.ImageJob.CreateParentDirectory">
<summary>
Defaults to false. When true, the parent directory of the destination filename will be created if it doesn't already exist.
</summary>
</member>
<member name="T:ImageResizer.Instructions">
<summary>
A name/value collection of image processsing instructions. The successor to ResizeSettings.
Just because a key doesn't have a property wrapper doesn't mean you can't use it. i["key"] = value; isnt' that scary.
</summary>
</member>
<member name="M:ImageResizer.Instructions.ToString">
<summary>
Returns a human-friendly representation of the instruction set. Not suitable for URL usage; use ToQueryString() for that.
</summary>
<returns></returns>
</member>
<member name="M:ImageResizer.Instructions.ToQueryString">
<summary>
Returns a URL-safe querystring containing the instruction set
</summary>
<returns></returns>
</member>
<member name="M:ImageResizer.Instructions.#ctor">
<summary>
Creates an empty instructions collection.
</summary>
</member>
<member name="M:ImageResizer.Instructions.#ctor(System.Collections.Specialized.NameValueCollection)">
<summary>
Copies the specified collection into a new Instructions instance.
</summary>
<param name="col"></param>
</member>
<member name="M:ImageResizer.Instructions.#ctor(System.String)">
<summary>
Parses the specified querystring into name/value pairs. Supports standard and semicolon syntaxes. The most readable format is 'key=value;key2=value2' Discards everything after the first '#' character as a URL fragment.
</summary>
<param name="queryString"></param>
</member>
<member name="P:ImageResizer.Instructions.Width">
<summary>
The width in pixels to constrain the image to. See 'Mode' and 'Scale' for constraint logic.
</summary>
</member>
<member name="P:ImageResizer.Instructions.Height">
<summary>
The height in pixels to constrain the image to. See 'Mode' and 'Scale' for constraint logic.
</summary>
</member>
<member name="P:ImageResizer.Instructions.Mode">
<summary>
The fit mode to use when both Width and Height are specified. Defaults to Pad.
</summary>
</member>
<member name="P:ImageResizer.Instructions.Anchor">
<summary>
The alignment to use when cropping or padding the image automatically. Defaults to MiddleCenter.
</summary>
</member>
<member name="P:ImageResizer.Instructions.SourceFlip">
<summary>
Flip instruction to perform immediately after loading source image. Maps to 'sflip' and 'sourceFlip'.
</summary>
</member>
<member name="P:ImageResizer.Instructions.FinalFlip">
<summary>
Flip instruction to perform after rendering is complete
</summary>
</member>
<member name="P:ImageResizer.Instructions.Scale">
<summary>
Control how upscaling is performed. Defaults to DownscaleOnly.
</summary>
</member>
<member name="P:ImageResizer.Instructions.Cache">
<summary>
Allows disk caching to be forced or prevented.
</summary>
</member>
<member name="P:ImageResizer.Instructions.Process">
<summary>
Allows processing to be forced or prevented.
</summary>
</member>
<member name="P:ImageResizer.Instructions.Frame">
<summary>
The frame of the animated GIF to display. 1-based
</summary>
</member>
<member name="P:ImageResizer.Instructions.Page">
<summary>
The page of the TIFF file to display. 1-based
</summary>
</member>
<member name="P:ImageResizer.Instructions.JpegQuality">
<summary>
Determines Jpeg encoding quality. Maps to 'quality' setting.
</summary>
</member>
<member name="P:ImageResizer.Instructions.JpegSubsampling">
<summary>
Maps to 'subsampling'. Requires encoder=wic|freeimage or builder=wic|freeimage to take effect. Not supported by the GDI pipeline.
</summary>
</member>
<member name="P:ImageResizer.Instructions.PaletteSize">
<summary>
Maps to 'colors'. Sets the palette size for the final png or gif image (not relevant for jpegs).
Set to 'null' to use the largest palette size available in the format.
Requires the PrettyGifs or WicEncoder plugin.
</summary>
</member>
<member name="P:ImageResizer.Instructions.Zoom">
<summary>
A multiplier to apply to all sizing settings (still obeys Scale=down, though). Useful when you need to apply a page-wide scaling factor, such as for mobile devices.
</summary>
</member>
<member name="P:ImageResizer.Instructions.CropXUnits">
<summary>
Defines the horizontal width of the crop rectangle's coordinate space. For example, setting this to 100 makes the crop X1 and X2 values percentages of the image width.
</summary>
</member>
<member name="P:ImageResizer.Instructions.CropYUnits">
<summary>
Defines the vertical height of the crop rectangle's coordinate space. For example, setting this to 100 makes the crop Y1 and Y1 values percentages of the image height.
</summary>
</member>
<member name="P:ImageResizer.Instructions.CropRectange">
<summary>
An X1,Y1,X2,Y2 array of coordinates. Unless CropXUnits and CropYUnits are specified, these are in the coordinate space of the original image.
</summary>
</member>
<member name="P:ImageResizer.Instructions.CropRectangle">
<summary>
An X1,Y1,X2,Y2 array of coordinates. Unless CropXUnits and CropYUnits are specified, these are in the coordinate space of the original image.
</summary>
</member>
<member name="P:ImageResizer.Instructions.AutoRotate">
<summary>
Automatically rotates images based on gravity sensor data embedded in Exif. Requires the AutoRotate plugin
</summary>
</member>
<member name="P:ImageResizer.Instructions.SourceRotate">
<summary>
Maps to 'srotate'. Rotates the source image prior to processing. Only 90 degree angles are currently supported.
</summary>
</member>
<member name="P:ImageResizer.Instructions.Rotate">
<summary>
Maps to 'rotate'. Rotates the image during rendering. Arbitrary angles are supported.
</summary>
</member>
<member name="P:ImageResizer.Instructions.Format">
<summary>
Use 'OutputFormat' unless you need a custom value. Determines the format and encoding of the output image.
</summary>
</member>
<member name="P:ImageResizer.Instructions.OutputFormat">
<summary>
Selects the image encoding format. Maps to 'format'. Returns null if the format is unspecified or if it isn't defined in the enumeration.
</summary>
</member>
<member name="P:ImageResizer.Instructions.IgnoreICC">
<summary>
If true, the ICC profile will be discared instead of being evaluated server side (which typically causes inconsistent and unexpected effects).
</summary>
</member>
<member name="P:ImageResizer.Instructions.FallbackImage">
<summary>
The fallback image to redirect to if the original image doesn't exist. Must be the name of a pre-defined 404 image or a filename in the default 404 images directory.
Requires the Image404 plugin to be installed.
</summary>
</member>
<member name="P:ImageResizer.Instructions.BackgroundColor">
<summary>
The color of margin and padding regions. Defaults to Transparent, or White (when jpeg is the selected output color).
</summary>
</member>
<member name="P:ImageResizer.Instructions.PaddingColor">
<summary>
Defaults to 'bgcolor'. Allows a separate color to be used for padding areas vs. margins.
</summary>
</member>
<member name="P:ImageResizer.Instructions.BorderColor">
<summary>
The color to draw the border with, if a border width is specified.
</summary>
</member>
<member name="P:ImageResizer.Instructions.Preset">
<summary>
The name of a pre-defined preset, or a comma-delimited list of presets to apply. These may overwrite other settings. Requires the Presets plugin.
</summary>
</member>
<member name="P:ImageResizer.Instructions.Watermark">
<summary>
The name of a pre-defined watermark layer or group from Web.config, or a comma-delimited list of names. Requires the Watermark plugin.
</summary>
</member>
<member name="P:ImageResizer.Instructions.Invert">
<summary>
Applies a Negative filter to the image. Requires the SimpleFilters plugin
</summary>
</member>
<member name="P:ImageResizer.Instructions.Sepia">
<summary>
Applies a Sepia filter to the image. Requires the SimpleFilters plugin
</summary>
</member>
<member name="P:ImageResizer.Instructions.Grayscale">
<summary>
Applies the specified kind of grayscale filter to the image. Requires the SimpleFilters plugin
</summary>
</member>
<member name="P:ImageResizer.Instructions.Alpha">
<summary>
Value between 0 and 1. Makes the rendered image transparent. Does not affect borders or background colors - those accept 4-byte colors with alpha channels, however.
Requires the SimpleFilters plugin. Unless the output format is PNG, the image will be blended against white or the background color.
</summary>
</member>
<member name="P:ImageResizer.Instructions.Brightness">
<summary>
-1..1 Adjust the brightness of the image. Requires the SimpleFilters plugin
</summary>
</member>
<member name="P:ImageResizer.Instructions.Contrast">
<summary>
-1..1 Adjust the contrast of the image. Requires the SimpleFilters plugin
</summary>
</member>
<member name="P:ImageResizer.Instructions.Saturation">
<summary>
-1..1 Adjust the saturation of the image. Requires the SimpleFilters plugin
</summary>
</member>
<member name="P:ImageResizer.Instructions.TrimThreshold">
<summary>
Setting this enables automatic whitespace trimming using an energy function. 50 is safe, even 255 rarely cuts anything off except a shadow. Set TrimPadding to pad the result slightly and improve appearance.
Requires the WhitespaceTrimmer plugin.
</summary>
</member>
<member name="P:ImageResizer.Instructions.TrimPadding">
<summary>
Set TrimThreshold first. This specifies a percentage of the image size to 'add' to the crop rectangle. Setting to 0.5 or 1 usually produces good results.
Requires the WhitespaceTrimmer plugin.
</summary>
</member>
<member name="P:ImageResizer.Instructions.Blur">
<summary>
Guassian Blur. Requires the AdvancedFilters plugin.
</summary>
</member>
<member name="P:ImageResizer.Instructions.Sharpen">
<summary>
Unsharp Mask. Requires the AdvancedFilters plugin.
</summary>
</member>
<member name="P:ImageResizer.Instructions.RemoveNoise">
<summary>
Safe noise removal. Requires the AdvancedFilters plugin.
</summary>
</member>
<member name="P:ImageResizer.Instructions.Dither">
<summary>
Controls dithering when rendering to an 8-bit PNG or GIF image. Requires PrettyGifs or WicEncoder. Accepted values for PrettyGifs: true|false|4pass|30|50|79|[percentage]. Accepted values for WicEncoder: true|false.
</summary>
</member>
<member name="P:ImageResizer.Instructions.Encoder">
<summary>
Specify a preferred encoder for compressing the output image file. Defaults to 'gdi'. Other valid values are 'freeimage' and 'wic', which require the FreeImageEncoder and WicEncoder plugins respectively.
FreeImage offers faster jpeg encoding, while WIC offers faster PNG and GIF encoding. Both, however, require full trust.
</summary>
</member>
<member name="P:ImageResizer.Instructions.Decoder">
<summary>
Specify a preferred decoder for parsing the original image file. Defaults to 'gdi'. Other values include 'freeimage', 'wic', and 'psdreader'. The preferred decoder gets the first chance at reading the files. If that fails, all other decoders try, in order of declaration in Web.config.
Requires the matching FreeImageDecoder, WicDecoder, or PsdReader plugin to be installed.
</summary>
</member>
<member name="P:ImageResizer.Instructions.Builder">
<summary>
Specify the image processing pipeline to use. Defaults to 'gdi'. If FreeImageBuilder or WicBuilder is installed, you can specify 'freeimage' or 'wic' to use that pipeline instead.
The WIC pipeline offers a 2-8X performance increase of GDI, at the expense of slightly reduced image quality, the full trust requirement, and support for only basic resize and crop commands.
FreeImage offers *nix-level image support, and handles many images that gdi and wic can't deal with. It is also restricted to a subset of the full command series.
</summary>
</member>
<member name="P:ImageResizer.Instructions.RoundCorners">
<summary>
Gets or sets a 1 or 4-element array defining cornder radii. If the array is 1 element, it applies to all corners. If it is 4 elements, each corner gets an individual radius. Values are percentages of the image width or height, whichever is smaller.
Requires the SimpleFilters plugin.
</summary>
</member>
<member name="P:ImageResizer.Instructions.Padding">
<summary>
["paddingWidth"]: Gets/sets the width(s) of padding inside the image border.
</summary>
</member>
<member name="P:ImageResizer.Instructions.Margin">
<summary>
["margin"]: Gets/sets the width(s) of the margin outside the image border and effects.
</summary>
</member>
<member name="P:ImageResizer.Instructions.Border">
<summary>
Friendly get/set accessor for the ["borderWidth"] value. Returns null when unspecified.
</summary>
</member>
<member name="T:ImageResizer.Resizing.BuilderExtension">
<summary>
Provides a useable base class that can be used to modify the behavior of ImageBuilder.
When registered with an ImageBuilder instance, the ImageBuilder will call the corresponding methods on the extension prior to executing its own methods.
</summary>
</member>
<member name="T:ImageResizer.Resizing.AbstractImageProcessor">
<summary>
Not for external use. Inherit from BuilderExtension instead.
Dual-purpose base class for both ImageBuilder and BuilderExtension
Extensions can inherit and override certain methods.
ImageBuilder inherits this method to utilize its extension invocation code.
Each method of AbstractImageProcessor loops through all extensions and executes the same method on each. Provides a sort of multiple-inheritance mechanisim.
</summary>
</member>
<member name="M:ImageResizer.Resizing.AbstractImageProcessor.#ctor">
<summary>
Creates a new AbstractImageProcessor with no extensions
</summary>
</member>
<member name="M:ImageResizer.Resizing.AbstractImageProcessor.#ctor(System.Collections.Generic.IEnumerable{ImageResizer.Resizing.BuilderExtension})">
<summary>
Creates a new AbstractImageProcessor which will run the specified extensions with each method call.
</summary>
<param name="extensions"></param>
</member>
<member name="F:ImageResizer.Resizing.AbstractImageProcessor.exts">
<summary>
Contains the set of extensions that are called for every method.
</summary>
</member>
<member name="M:ImageResizer.Resizing.AbstractImageProcessor.PreLoadImage(System.Object@,System.String@,System.Boolean@,ImageResizer.ResizeSettings@)">
<summary>
Extend this to allow additional types of source objects to be accepted by transforming them into Bitmap instances.
</summary>
<param name="source"></param>
<param name="path"></param>
<param name="disposeSource"></param>
<param name="settings"></param>
</member>
<member name="M:ImageResizer.Resizing.AbstractImageProcessor.GetStream(System.Object,ImageResizer.ResizeSettings,System.Boolean@,System.String@,System.Boolean@)">
<summary>
Extend this to allow additional types of source objects to be accepted by transforming them into Stream instances. First plugin to return a Stream wins.
</summary>
<param name="source"></param>
<param name="settings"></param>
<param name="disposeStream"></param>
<param name="path"></param>
<param name="restoreStreamPosition"></param>
<returns></returns>
</member>
<member name="M:ImageResizer.Resizing.AbstractImageProcessor.DecodeStreamFailed(System.IO.Stream,ImageResizer.ResizeSettings,System.String)">
<summary>
Extensions are executed until one extension returns a non-null value.
This is taken to mean that the error has been resolved.
Extensions should not throw an exception unless they wish to cause subsequent extensions to not execute.
If extensions throw an ArgumentException or ExternalException, it will be wrapped in an ImageCorruptedException instance.
If the Bitmap class is used for decoding, read gdi-bugs.txt and make sure you set b.Tag to new BitmapTag(optionalPath,stream);
</summary>
</member>
<member name="M:ImageResizer.Resizing.AbstractImageProcessor.DecodeStream(System.IO.Stream,ImageResizer.ResizeSettings,System.String)">
<summary>
Extend this to support alternate image source formats.
If the Bitmap class is used for decoding, read gdi-bugs.txt and make sure you set b.Tag to new BitmapTag(optionalPath,stream);
</summary>
<param name="s"></param>
<param name="settings"></param>
<param name="optionalPath"></param>
<returns></returns>
</member>
<member name="M:ImageResizer.Resizing.AbstractImageProcessor.PostDecodeStream(System.Drawing.Bitmap@,ImageResizer.ResizeSettings)">
<summary>
Extend this to modify the Bitmap instance after it has been decoded by DecodeStream or DecodeStreamFailed
</summary>
</member>
<member name="M:ImageResizer.Resizing.AbstractImageProcessor.PreAcquireStream(System.Object@,ImageResizer.ResizeSettings)">
<summary>
Extend this to allow additional types of *destination* objects to be accepted by transforming them into a stream.
</summary>
<param name="dest"></param>
<param name="settings"></param>
</member>
<member name="M:ImageResizer.Resizing.AbstractImageProcessor.BuildJob(ImageResizer.ImageJob)">
<summary>
The method to override if you want to replace the entire pipeline.
All Build() calls call this method first.
Does nothing in ImageBuilder
</summary>
<param name="job"></param>
<returns></returns>
</member>
<member name="M:ImageResizer.Resizing.AbstractImageProcessor.buildToStream(System.Drawing.Bitmap,System.IO.Stream,ImageResizer.ResizeSettings)">
<summary>
Called for Build() calls that want the result encoded. (Not for Bitmap Build(source,settings) calls.
Only override this method if you need to replace the behavior of image encoding and image processing together, such as adding support
for resizing multi-page TIFF files or animated GIFs.
Does NOT dispose of 'source' or 'source's underlying stream.
</summary>
<param name="source"></param>
<param name="dest"></param>
<param name="settings"></param>
<returns></returns>
</member>
<member name="M:ImageResizer.Resizing.AbstractImageProcessor.buildToBitmap(System.Drawing.Bitmap,ImageResizer.ResizeSettings,System.Boolean)">
<summary>
Most calls funnel through here. Default behavior configures an ImageState instance and calls Process(imageState);
Shouldn't be overriden for any reason I can think of - use the appropriate virtual method under Process().
If an extension returns a Bitmap instance, it will be used instead of the default behavior.
Does NOT dispose of 'source' or 'source's underlying stream.
</summary>
<param name="source"></param>
<param name="settings"></param>
<param name="transparencySupported"></param>
<returns></returns>
</member>
<member name="M:ImageResizer.Resizing.AbstractImageProcessor.OnProcess(ImageResizer.Resizing.ImageState)">
<summary>
Process.0 First step of the Process() method. Can replace the entire Process method if RequestAction.Cancel is returned.
Can be used to add points to translate (for image maps), and also to modify the settings