Skip to content

Commit 64f4448

Browse files
committed
Documentation updates
Modified the readme file to include the wiki pages and conglomerated some duplicate information. Also removed old wiki pages and folder.
1 parent 134c4c3 commit 64f4448

File tree

3 files changed

+50
-89
lines changed

3 files changed

+50
-89
lines changed

README.md

Lines changed: 50 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -9,53 +9,72 @@ The ASPNetImage component essentially exposes part of the System.Drawing namespa
99
A debug and release build of the DLL is included in the repository, or you can compile it yourself after generating a signing key. Checkout a working copy of the source repository or you may download the current release in the Downloads section.
1010

1111

12-
# Implementation Details
13-
It is a work in progress and any help completing the object is appreciated. All properties and methods are stubbed out, but as of this writing, currently only a small subset of properties and methods are implemented either in part or whole.
12+
# Properties and Methods
13+
ASPNetImage is a work in progress and any help completing the object is appreciated. All properties and methods are stubbed out, but as of this writing, currently only a small subset of properties and methods are implemented either in part or whole.
1414

1515

16-
**Fully Implemented**
16+
## Properties
1717

18-
*Properties:*
18+
* *AutoClear*:boolean<br />If true, class will automatically dispose image data when the SaveImage method is called. Default is true.
1919

20-
* AutoClear
21-
* Expires - Always returns future date
22-
* Filename
23-
* JPEGQuality
24-
* RegisteredTo - Returns "This Organization" by default, but can be set to any string
25-
* Version - Returns last known ASPImage version with "(ASPNetImage)" appended
20+
* *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._
2621

27-
*Methods:*
22+
* *Expires*:DateTime<br />Returns the date that the component expires. Included for compatibility. Always returns future date
2823

29-
* BrightenImage
30-
* ClearImage
31-
* CropImage
32-
* DarkenImage
33-
* FillRect
34-
* FlipImage
35-
* GetImageFileSize
36-
* LoadImage
37-
* Resize
24+
* *Error*:string<br />_Partially implemented._ Returns the last error from LoadImage and SaveImage methods only.
3825

26+
* *Filename*:string<br />Gets or sets the full path and filename to be used by the SaveImage method
3927

40-
**Partially Implemented**
28+
* *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.
4129

42-
*Properties:*
30+
* *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.
4331

44-
* Error - Returns the error from LoadImage and SaveImage methods only.
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
4533

46-
* ImageFormat - Only JPEG, BMP, GIF and PNG formats are supported for output
34+
* *Version*:string<br />Returns last known ASPImage version with "(ASPNetImage)" appended
4735

48-
*Methods:*
4936

50-
* ResizeR - Calls the Resize method.
37+
## Methods
5138

52-
* RotateImage - Only rotates at 90, 180 and 270 degrees clockwise
39+
* *BrightenImage*<br />Increases the brightness of the image
5340

54-
* SaveImage - Saves the image, but currently only in JPEG format.
41+
* *ClearImage*<br />Clears the image
5542

43+
* *CropImage*<br />Crops the image
5644

57-
**Additional Properties And Methods**
45+
* *DarkenImage*<br />Darkens the image
5846

59-
* ConstrainResize - When set to true, automatically crops the image during a resize to fit the dimensions and retain the original image's aspect ratio
47+
* *FillRect*<br />Fills a rectangle area of the image with a given color.
6048

61-
* GetImageSize - Returns the image dimensions for the currently loaded image
49+
* *FlipImage*<br />Flips the image
50+
51+
* *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.
52+
53+
* *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
58+
59+
* *ResizeR*<br />_Partially implemented._ Calls the Resize method.
60+
61+
* *RotateImage*<br />_Partially implemented._ Rotates the image. Currently only rotates at 90, 180 and 270 degrees clockwise
62+
63+
* *SaveImage*<br />_Partially implemented._ Saves the image, but currently only in JPEG format.
64+
65+
66+
# Troubleshooting
67+
68+
**Troubleshooting Installation Issues**
69+
70+
* Verify that the .NET Framework v2.0 is installed and working properly.
71+
72+
* Ensure that you've registered the DLL with REGASM.EXE with the /tlb and /codebase command line switches (see the included register.bat file). You may want to unregister the DLL and re-register them to confirm.
73+
74+
* Make sure the DLL and TLB files have the correct file permissions. Give read/write/execute access to NETWORK, NETWORK_SERVICE and the IUSER_[machineName] accounts.
75+
76+
If you are using an unsigned DLL, you will receive the following error message when registering the DLL with REGASM.EXE:
77+
78+
> RegAsm : warning RA0000 : Registering an unsigned assembly with /codebase can cause your assembly to interfere with other applications that may be installed on the same computer. The /codebase switch is intended to be used only with signed assemblies. Please give your assembly a strong name and re-register it.""
79+
80+
The object should still work, but I'd recommend unregistering it, compiling and signing the DLL yourself before registering it again so that you don't receive the warning message. Visual Studio 2005 and up can do this automatically from the Project Properties panel on the "Signing" tab. Just pick "< New >" and follow the prompts.

Wiki/ClassDetails.wiki

Lines changed: 0 additions & 43 deletions
This file was deleted.

Wiki/Troubleshooting.wiki

Lines changed: 0 additions & 15 deletions
This file was deleted.

0 commit comments

Comments
 (0)