Skip to content

Commit a93f5ac

Browse files
committed
Added additionally added methods and properties to readme file.
1 parent 98bce22 commit a93f5ac

File tree

1 file changed

+78
-16
lines changed

1 file changed

+78
-16
lines changed

README.md

Lines changed: 78 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -14,53 +14,115 @@ ASPNetImage is a work in progress and any help completing the object is apprecia
1414

1515

1616
## Properties
17+
18+
* *AntiAliasText*:boolean<br />Gets or sets whether anti-aliased text is added on the image. Default is true.
1719

1820
* *AutoClear*:boolean<br />If true, class will automatically dispose image data when the SaveImage method is called. Default is true.
21+
22+
* *BackgroundColor*:int<br />Gets or sets the background color for future image manipulations.
23+
24+
* *Bold*:boolean<br />Gets or sets whether text is to be rendered in bold faced style. Default is false.
1925

2026
* *ConstrainResize*:boolean<br />When set to true, automatically crops the image during a resize to fit the dimensions and retain the original image's aspect ratio. Default is true. _New with ASPNetImage._
21-
22-
* *Expires*:DateTime<br />Returns the date that the component expires. Included for compatibility. Always returns future date
27+
28+
* *DPI*:int<br />Gets or sets the DPI for the current image. Default is 96.
2329

2430
* *Error*:string<br />_Partially implemented._ Returns the last error from LoadImage and SaveImage methods only.
2531

26-
* *Filename*:string<br />Gets or sets the full path and filename to be used by the SaveImage method
32+
* *Expires*:DateTime<br />Returns the date that the component expires. Included for compatibility. Always returns future date.
33+
34+
* *Filename*:string<br />Gets or sets the full path and filename to be used by the SaveImage method.
35+
36+
* *FontColor*:int<br />Gets or sets the argb color value to be used when rendering text.
37+
38+
* *FontName*:string<br />Gets or sets the name of the font to be used when drawing text. Default is "MS Sans Serif."
39+
40+
* *FontSize*:int<br />Gets or sets the pixel size of the font to be used when rendering text. Default is 12 pixels.
2741

2842
* *ImageFormat*:int<br />_Partially implemented._ Gets or sets the image format to be used by the SaveImage method. Currently only JPEG format is supported for output. Enumerated. See ASPNetImage.ImageFormats.
2943

3044
* *JPEGQuality*:int<br />Gets or sets the output quality percentage of JPEG images when SaveImage is called to save a JPEG. Valid amounts are 1 to 100.
31-
32-
* *RegisteredTo*:string<br />Gets or sets the name that the component is registered to. Included for compatibility. Returns "This Organization" by default, but can be set to any string
33-
34-
* *Version*:string<br />Returns last known ASPImage version with "(ASPNetImage)" appended
45+
46+
* *MaxX*:int<br />Gets or sets the width of the image.
47+
48+
* *MaxY*:int<br />Gets or sets the height of the image.
49+
50+
* *PenColor*:int<br />Gets or sets the argb color value to be used when drawing using the pen.
51+
52+
* *PenStyle*:int<br />Gets or sets the line style to be used when drawing using the pen.
53+
54+
* *PenWidth*:int<br />Gets or sets the pixel width of the pen when drawing.
55+
56+
* *ProgressiveJPEGEncoding*:boolean<br />Gets or sets whether JPG images should be saved with progressive encoding.
57+
58+
* *RawNetImage*:Image<br />Returns the .NET Image instance.
59+
60+
* *RegisteredTo*:string<br />Gets or sets the name that the component is registered to. Included for compatibility. Returns "This Organization" by default, but can be set to any string.
61+
62+
* *TextAngle*:int<br />Gets or sets the angle to be used when rendering text. Default is 0 (horizontal).
63+
64+
* *Version*:string<br />Returns last known ASPImage version with "(ASPNetImage vX.X)" appended.
65+
66+
* *X*:Int32<br />Gets or sets the current X coordinate of the pen used for drawing.
67+
68+
* *Y*:Int32<br />Gets or sets the current X coordinate of the pen used for drawing.
3569

3670

3771
## Methods
3872

39-
* *BrightenImage*<br />Increases the brightness of the image
73+
* *AddImage*<br />Adds a new image to the canvas using the provided coordinates.
4074

41-
* *ClearImage*<br />Clears the image
75+
* *BrightenImage*<br />Increases the brightness of the image.
4276

43-
* *CropImage*<br />Crops the image
77+
* *ClearImage*<br />Clears the image.
78+
79+
* *Contrast*<br />Modifies the image's contrast.
80+
81+
* *CreateGrayScale*<br />Converts the image into a gray scale image.
82+
83+
* *CreateNegative*<br />Creates a negative image effect of the current image.
4484

45-
* *DarkenImage*<br />Darkens the image
85+
* *CropImage*<br />Crops the image.
86+
87+
* *DarkenImage*<br />Darkens the image.
88+
89+
* *Emboss*<br />Creates an embossing effect on the image.
4690

4791
* *FillRect*<br />Fills a rectangle area of the image with a given color.
4892

49-
* *FlipImage*<br />Flips the image
93+
* *FlipImage*<br />Flips the image.
5094

5195
* *GetImageFileSize*<br />Returns the image dimensions for the image specified by full file path and name. Currently incurs memory hit as image has to be loaded to determine dimensions.
5296

5397
* *GetImageSize*<br />Returns the image dimensions for the currently loaded image. _New with ASPNetImage._
54-
55-
* *LoadImage*<br />Loads an image from disk at the specified filepath
56-
57-
* *Resize*<br />Resizes the image
98+
99+
* *GetPixel*<br />Returns the color value (argb) for the pixel at the specified x and y coordinates.
100+
101+
* *LineTo*<br />Draws a line from the current pen coordinates to the specified destination with the current pen color and width.
102+
103+
* *LoadBlob*<br />Loads binary imag data onto the image canvas.
104+
105+
* *LoadImage*<br />Loads an image from disk at the specified filepath.
106+
107+
* *Rectangle*<br />Draws a rectangle with the coordinates of the upper-left and lower-right coordinates provided.
108+
109+
* *Resize*<br />Resizes the image.
110+
111+
* *ResizeOnHeight*<br />Resize proportionally based on height. _New with ASPNetImage._
112+
113+
* *ResizeOnWidth*<br />Resize proportionally based on width. _New with ASPNetImage._
58114

59115
* *ResizeR*<br />_Partially implemented._ Calls the Resize method.
60116

61117
* *RotateImage*<br />_Partially implemented._ Rotates the image. Currently only rotates at 90, 180 and 270 degrees clockwise
62118

63119
* *SaveImage*<br />_Partially implemented._ Saves the image, but currently only in JPEG format.
120+
121+
* *TextHeight*<br />Returns the text height of a string using the current font, font size and font characteristics.
122+
123+
* *TextOut*<br />Writes a string of text using the current font, font size and font characteristics.
124+
125+
* *TextWidth*<br />Returns the text width for a string value using the current font, font size and font characteristics.
64126

65127

66128
# Environment Configuration

0 commit comments

Comments
 (0)