-
Notifications
You must be signed in to change notification settings - Fork 10
Add FAQ about ObjectDataSource controls #23
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
lscorcia
wants to merge
1
commit into
daiplusplus:master
Choose a base branch
from
lscorcia:master
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
64 changes: 64 additions & 0 deletions
64
AspNetDependencyInjection/AspNetDependencyInjection.WebForms/DiObjectDataSource.cs
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,64 @@ | ||
| using System; | ||
| using System.Collections.Generic; | ||
| using System.Linq; | ||
| using System.Text; | ||
| using System.Threading.Tasks; | ||
| using System.Web; | ||
| using System.Web.Compilation; | ||
| using System.Web.UI.WebControls; | ||
|
|
||
| namespace AspNetDependencyInjection.WebForms | ||
| { | ||
| /// <summary> | ||
| /// A drop-in replacement for <see cref="ObjectDataSource" /> controls that enables dependency injection | ||
| /// instantiation for data sources. | ||
| /// | ||
| /// To use it, register the control namespace by adding the following element to your web.config file: | ||
| /// | ||
| /// <c> | ||
| /// <configuration> | ||
| /// <system.web> | ||
| /// <pages> | ||
| /// <controls> | ||
| /// ... | ||
| /// <add tagPrefix="di" namespace="AspNetDependencyInjection.WebForms" assembly="AspNetDependencyInjection" /> | ||
| /// ... | ||
| /// </controls> | ||
| /// </pages> | ||
| /// </system.web> | ||
| /// </configuration> | ||
| /// </c> | ||
| /// | ||
| /// Then replace the <asp:ObjectDataSource> tags in your code with <di:DiObjectDataSource> tags. | ||
| /// </summary> | ||
| /// <remarks> | ||
| /// Please make sure your <see cref="ObjectDataSource" /> methods are not marked <see langword="static" />. | ||
| /// </remarks> | ||
| public class DiObjectDataSource : ObjectDataSource | ||
| { | ||
| /// <summary> | ||
| /// Background: <see cref="ObjectDataSource" /> controls invoke a `Select` method defined | ||
| /// in the `Page` object in order to retrieve the data to bind to other controls. This select method is | ||
| /// usually a <see langword="static" /> method on the containing page, which prevents using DI, | ||
| /// but can also be an instance method, in which case it instantiates a new `Page` object and calls the method | ||
| /// on the newly created instance. | ||
| /// That's the scenario when DI should be possible. | ||
| /// | ||
| /// Unfortunately it seems that Microsoft never updated the <see cref="ObjectDataSource" /> control | ||
| /// to use <see cref="HttpRuntime.WebObjectActivator" />, | ||
| /// so it's not able to instantiate DI-enabled `Page` controls. | ||
| /// However, it is possible to override its <see cref="ObjectDataSource.ObjectCreating" /> | ||
| /// event to make it work the way we want. | ||
| /// </summary> | ||
| public DiObjectDataSource() | ||
| { | ||
| // We need to use `BuildManager.GetType` instead of `Type.GetType` because this method is actually | ||
| // able to look for the type in all of the application assemblies - otherwise we'd be restricted | ||
| // to the current assembly types. | ||
|
|
||
| this.ObjectCreating += ( sender, args ) => | ||
| args.ObjectInstance = HttpRuntime.WebObjectActivator.GetService( BuildManager.GetType( | ||
| ( (ObjectDataSourceView)sender ).TypeName, throwOnError: false, ignoreCase: true ) ); | ||
| } | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I need to split-up the
GETTING_STARTED.mdfile into smaller doc files under/docs/*to keep them more focused. I'll do that now and invite you to submit this as a new doc file there.